From f5de351105ea7b8564507b516708ec51c8b61003 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Crocquesel?= <88554524+scrocquesel@users.noreply.github.com> Date: Fri, 20 Sep 2024 18:21:18 +0200 Subject: [PATCH] feat: introduce multiple clients --- build-parent/pom.xml | 17 +- .../deployment/CloudWatchProcessor.java | 28 +- .../cloudwatch/runtime/CloudWatchConfig.java | 19 +- .../runtime/CloudWatchRecorder.java | 9 +- .../deployment/CloudWatchLogsProcessor.java | 31 +- .../runtime/CloudWatchLogsConfig.java | 19 +- .../runtime/CloudWatchLogsRecorder.java | 9 +- .../deployment/CognitoUserPoolsProcessor.java | 31 +- .../runtime/CognitoUserPoolsConfig.java | 19 +- .../runtime/CognitoUserPoolsRecorder.java | 12 +- .../AbstractAmazonServiceProcessor.java | 296 +- .../AmazonClientAsyncResultBuildItem.java | 8 +- .../AmazonClientSyncResultBuildItem.java | 8 +- .../AmazonServicesClientsProcessor.java | 19 +- .../deployment/ClientDeploymentUtil.java | 66 + ...RequireAmazonClientInjectionBuildItem.java | 27 + ...mazonClientTransportBuilderBuildItem.java} | 6 +- .../quarkus/amazon/common/AmazonClient.java | 40 + .../amazon/common/AmazonClientBuilder.java | 40 + .../runtime/AmazonClientCommonRecorder.java | 131 +- .../common/runtime/AmazonClientConfig.java | 21 + .../common/runtime/AmazonClientRecorder.java | 5 +- .../amazon/common/runtime/AwsConfig.java | 2 +- .../amazon/common/runtime/ClientUtil.java | 9 + .../runtime/HasAmazonClientRuntimeConfig.java | 20 + .../amazon/common/runtime/SdkConfig.java | 6 +- docs/modules/ROOT/nav.adoc | 3 +- .../ROOT/pages/amazon-cognitouserpools.adoc | 2 +- docs/modules/ROOT/pages/amazon-s3.adoc | 4 +- docs/modules/ROOT/pages/common-features.adoc | 29 + docs/modules/ROOT/pages/dev-services.adoc | 8 +- .../includes/quarkus-amazon-cloudwatch.adoc | 3003 ++++------------- ...-amazon-cloudwatch_quarkus.cloudwatch.adoc | 1751 ++++++++++ .../quarkus-amazon-cloudwatchlogs.adoc | 776 +++-- ...cloudwatchlogs_quarkus.cloudwatchlogs.adoc | 1751 ++++++++++ ...=> quarkus-amazon-cognito-user-pools.adoc} | 768 ++--- ...user-pools_quarkus.cognito-user-pools.adoc | 1751 ++++++++++ .../quarkus-amazon-dynamodb-enhanced.adoc | 28 +- ...odb-enhanced_quarkus.dynamodbenhanced.adoc | 50 + .../includes/quarkus-amazon-dynamodb.adoc | 792 ++--- ...rkus-amazon-dynamodb_quarkus.dynamodb.adoc | 1768 ++++++++++ .../pages/includes/quarkus-amazon-ecr.adoc | 768 ++--- .../quarkus-amazon-ecr_quarkus.ecr.adoc | 1751 ++++++++++ .../includes/quarkus-amazon-eventbridge.adoc | 768 ++--- ...mazon-eventbridge_quarkus.eventbridge.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-iam.adoc | 768 ++--- .../quarkus-amazon-iam_quarkus.iam.adoc | 1751 ++++++++++ .../includes/quarkus-amazon-inspector.adoc | 815 +++-- .../includes/quarkus-amazon-inspector2.adoc | 815 +++-- ...-amazon-inspector2_quarkus.inspector2.adoc | 1751 ++++++++++ ...us-amazon-inspector_quarkus.inspector.adoc | 1751 ++++++++++ .../includes/quarkus-amazon-kinesis.adoc | 768 ++--- ...uarkus-amazon-kinesis_quarkus.kinesis.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-kms.adoc | 768 ++--- .../quarkus-amazon-kms_quarkus.kms.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-lambda.adoc | 768 ++--- .../quarkus-amazon-lambda_quarkus.lambda.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-s3.adoc | 894 ++--- .../quarkus-amazon-s3_quarkus.s3.adoc | 1981 +++++++++++ .../quarkus-amazon-secretsmanager.adoc | 768 ++--- ...secretsmanager_quarkus.secretsmanager.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-ses.adoc | 768 ++--- .../quarkus-amazon-ses_quarkus.ses.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-sfn.adoc | 768 ++--- .../quarkus-amazon-sfn_quarkus.sfn.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-sns.adoc | 768 ++--- .../quarkus-amazon-sns_quarkus.sns.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-sqs.adoc | 788 ++--- .../quarkus-amazon-sqs_quarkus.sqs.adoc | 1768 ++++++++++ .../pages/includes/quarkus-amazon-ssm.adoc | 768 ++--- .../quarkus-amazon-ssm_quarkus.ssm.adoc | 1751 ++++++++++ .../pages/includes/quarkus-amazon-sts.adoc | 768 ++--- .../quarkus-amazon-sts_quarkus.sts.adoc | 1751 ++++++++++ ...g.adoc => quarkus-amazon_quarkus.aws.adoc} | 132 +- ....adoc => quarkus-amazon_quarkus.otel.adoc} | 52 +- ...o-moto-dev-services-build-time-config.adoc | 47 - docs/modules/ROOT/pages/opentelemetry.adoc | 2 +- docs/pom.xml | 36 +- .../DynamodbEnhancedDbTableProcessor.java | 38 +- .../deployment/DynamodbEnhancedProcessor.java | 59 +- .../DynamoDbEnhancedClientTest.java | 42 + .../DynamodbEnhancedClientRecorder.java | 23 +- .../deployment/DynamodbProcessor.java | 30 +- .../dynamodb/runtime/DynamodbConfig.java | 31 +- .../dynamodb/runtime/DynamodbRecorder.java | 12 +- .../amazon/ecr/deployment/EcrProcessor.java | 29 +- .../quarkus/amazon/ecr/runtime/EcrConfig.java | 19 +- .../amazon/ecr/runtime/EcrRecorder.java | 12 +- .../deployment/EventBridgeProcessor.java | 34 +- .../runtime/EventBridgeConfig.java | 19 +- .../runtime/EventBridgeRecorder.java | 12 +- .../amazon/iam/deployment/IamProcessor.java | 29 +- .../quarkus/amazon/iam/runtime/IamConfig.java | 19 +- .../amazon/iam/runtime/IamRecorder.java | 12 +- .../deployment/InspectorProcessor.java | 30 +- .../inspector/runtime/InspectorConfig.java | 19 +- .../inspector/runtime/InspectorRecorder.java | 12 +- .../deployment/Inspector2Processor.java | 31 +- .../inspector2/runtime/Inspector2Config.java | 19 +- .../runtime/Inspector2Recorder.java | 12 +- .../io/quarkus/it/amazon/iam/IamResource.java | 18 + .../it/amazon/kinesis/KinesisResource.java | 5 +- .../io/quarkus/it/amazon/s3/S3Resource.java | 2 + .../S3TransferManagerResource.java | 5 +- .../src/main/resources/application.properties | 6 +- .../io/quarkus/it/amazon/AmazonIamTest.java | 10 +- .../kinesis/deployment/KinesisProcessor.java | 30 +- .../amazon/kinesis/runtime/KinesisConfig.java | 19 +- .../kinesis/runtime/KinesisRecorder.java | 12 +- .../amazon/kms/deployment/KmsProcessor.java | 29 +- .../quarkus/amazon/kms/runtime/KmsConfig.java | 19 +- .../amazon/kms/runtime/KmsRecorder.java | 12 +- .../lambda/deployment/LambdaProcessor.java | 31 +- .../amazon/lambda/runtime/LambdaConfig.java | 15 +- .../amazon/lambda/runtime/LambdaRecorder.java | 9 +- .../S3TransferManagerProcessor.java | 13 +- .../amazon/s3/deployment/S3CrtProcessor.java | 41 +- .../amazon/s3/deployment/S3Processor.java | 29 +- .../amazon/s3/deployment/S3CrtClientTest.java | 32 + ...ProviderMissedBeanNameNamedClientTest.java | 37 + ...CredentialsProviderMissedBeanNameTest.java | 7 + ...stomCredentialsProviderMissedBeanTest.java | 7 + .../s3/deployment/S3DevServicesTest.java | 7 + .../S3SyncClientFullConfigTest.java | 18 +- ...ovider-missed-name-named-client.properties | 3 + .../sync-urlconn-full-config.properties | 2 +- .../quarkus/amazon/s3/runtime/S3Config.java | 19 +- .../amazon/s3/runtime/S3CrtRecorder.java | 23 +- .../quarkus/amazon/s3/runtime/S3Recorder.java | 13 +- .../deployment/SecretsManagerProcessor.java | 34 +- .../runtime/SecretsManagerConfig.java | 19 +- .../runtime/SecretsManagerRecorder.java | 12 +- .../amazon/ses/deployment/SesProcessor.java | 29 +- .../quarkus/amazon/ses/runtime/SesConfig.java | 19 +- .../amazon/ses/runtime/SesRecorder.java | 12 +- .../amazon/sfn/deployment/SfnProcessor.java | 29 +- .../quarkus/amazon/sfn/runtime/SfnConfig.java | 19 +- .../amazon/sfn/runtime/SfnRecorder.java | 12 +- .../amazon/sns/deployment/SnsProcessor.java | 29 +- .../quarkus/amazon/sns/runtime/SnsConfig.java | 19 +- .../amazon/sns/runtime/SnsRecorder.java | 12 +- .../amazon/sqs/deployment/SqsProcessor.java | 29 +- .../SqsDevServicesWithoutQueueTest.java | 7 + .../quarkus/amazon/sqs/runtime/SqsConfig.java | 19 +- .../amazon/sqs/runtime/SqsRecorder.java | 12 +- .../amazon/ssm/deployment/SsmProcessor.java | 29 +- .../quarkus/amazon/ssm/runtime/SsmConfig.java | 19 +- .../amazon/ssm/runtime/SsmRecorder.java | 12 +- .../amazon/sts/deployment/StsProcessor.java | 29 +- .../quarkus/amazon/sts/runtime/StsConfig.java | 19 +- .../amazon/sts/runtime/StsRecorder.java | 12 +- 151 files changed, 45187 insertions(+), 10703 deletions(-) create mode 100644 common/deployment/src/main/java/io/quarkus/amazon/common/deployment/ClientDeploymentUtil.java create mode 100644 common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientInjectionBuildItem.java rename common/deployment/src/main/java/io/quarkus/amazon/common/deployment/{AmazonClientBuildItem.java => RequireAmazonClientTransportBuilderBuildItem.java} (86%) create mode 100644 common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClient.java create mode 100644 common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClientBuilder.java create mode 100644 common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientConfig.java create mode 100644 common/runtime/src/main/java/io/quarkus/amazon/common/runtime/ClientUtil.java create mode 100644 common/runtime/src/main/java/io/quarkus/amazon/common/runtime/HasAmazonClientRuntimeConfig.java create mode 100644 docs/modules/ROOT/pages/common-features.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch_quarkus.cloudwatch.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs_quarkus.cloudwatchlogs.adoc rename docs/modules/ROOT/pages/includes/{quarkus-amazon-cognitouserpools.adoc => quarkus-amazon-cognito-user-pools.adoc} (61%) create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools_quarkus.cognito-user-pools.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb_quarkus.dynamodb.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-ecr_quarkus.ecr.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge_quarkus.eventbridge.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-iam_quarkus.iam.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2_quarkus.inspector2.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-inspector_quarkus.inspector.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis_quarkus.kinesis.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-kms_quarkus.kms.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-lambda_quarkus.lambda.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-s3_quarkus.s3.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager_quarkus.secretsmanager.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-ses_quarkus.ses.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-sfn_quarkus.sfn.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-sns_quarkus.sns.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-sqs_quarkus.sqs.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-ssm_quarkus.ssm.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-sts_quarkus.sts.adoc rename docs/modules/ROOT/pages/includes/{quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc => quarkus-amazon_quarkus.aws.adoc} (56%) rename docs/modules/ROOT/pages/includes/{quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc => quarkus-amazon_quarkus.otel.adoc} (64%) delete mode 100644 docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc create mode 100644 dynamodb-enhanced/deployment/src/test/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamoDbEnhancedClientTest.java create mode 100644 s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CrtClientTest.java create mode 100644 s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameNamedClientTest.java create mode 100644 s3/deployment/src/test/resources/custom-credentials-provider-missed-name-named-client.properties diff --git a/build-parent/pom.xml b/build-parent/pom.xml index 61c977136..8c5cd81a9 100644 --- a/build-parent/pom.xml +++ b/build-parent/pom.xml @@ -30,5 +30,20 @@ - + + + + + io.quarkus + quarkus-maven-plugin + ${quarkus.version} + + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + + + + diff --git a/cloudwatch/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchProcessor.java b/cloudwatch/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchProcessor.java index 7af31dde0..617d8fb90 100644 --- a/cloudwatch/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchProcessor.java +++ b/cloudwatch/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchProcessor.java @@ -65,10 +65,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -79,7 +87,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -87,7 +95,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, CloudWatchRecorder recorder, + void setupApacheSyncTransport(List amazonClients, CloudWatchRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -100,7 +108,7 @@ void setupApacheSyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, CloudWatchRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, CloudWatchRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -113,7 +121,8 @@ void setupAwsCrtSyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, CloudWatchRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + CloudWatchRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -126,7 +135,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, CloudWatchRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, CloudWatchRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -140,7 +149,8 @@ void setupNettyAsyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, CloudWatchRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + CloudWatchRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -156,6 +166,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, CloudW void createClientBuilders(CloudWatchRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -170,6 +181,7 @@ void createClientBuilders(CloudWatchRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchConfig.java b/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchConfig.java index ae9a8d4fc..83472785e 100644 --- a/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchConfig.java +++ b/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.cloudwatch.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.cloudwatch") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface CloudWatchConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface CloudWatchConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchRecorder.java b/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchRecorder.java index bf0601145..7f7b71da1 100644 --- a/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchRecorder.java +++ b/cloudwatch/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchRecorder.java @@ -18,13 +18,8 @@ public CloudWatchRecorder(CloudWatchConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/cloudwatchlogs/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchLogsProcessor.java b/cloudwatchlogs/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchLogsProcessor.java index f1d967c93..908db8189 100644 --- a/cloudwatchlogs/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchLogsProcessor.java +++ b/cloudwatchlogs/deployment/src/main/java/io/quarkus/amazon/cloudwatch/deployment/CloudWatchLogsProcessor.java @@ -65,10 +65,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -79,7 +87,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -87,7 +95,8 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, CloudWatchLogsRecorder recorder, + void setupApacheSyncTransport(List amazonClients, + CloudWatchLogsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -100,7 +109,8 @@ void setupApacheSyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, CloudWatchLogsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, + CloudWatchLogsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -113,7 +123,8 @@ void setupAwsCrtSyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, CloudWatchLogsRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + CloudWatchLogsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -126,7 +137,8 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, CloudWatchLogsRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, + CloudWatchLogsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -140,7 +152,8 @@ void setupNettyAsyncTransport(List amazonClients, CloudWa @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, CloudWatchLogsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + CloudWatchLogsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -156,6 +169,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, CloudW void createClientBuilders(CloudWatchLogsRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -170,6 +184,7 @@ void createClientBuilders(CloudWatchLogsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsConfig.java b/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsConfig.java index be4f66c31..4c3d9ab69 100644 --- a/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsConfig.java +++ b/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.cloudwatch.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.cloudwatchlogs") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface CloudWatchLogsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface CloudWatchLogsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsRecorder.java b/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsRecorder.java index 6a47ff146..66585ab52 100644 --- a/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsRecorder.java +++ b/cloudwatchlogs/runtime/src/main/java/io/quarkus/amazon/cloudwatch/runtime/CloudWatchLogsRecorder.java @@ -18,13 +18,8 @@ public CloudWatchLogsRecorder(CloudWatchLogsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/cognito-user-pools/deployment/src/main/java/io/quarkus/amazon/cognitouserpools/deployment/CognitoUserPoolsProcessor.java b/cognito-user-pools/deployment/src/main/java/io/quarkus/amazon/cognitouserpools/deployment/CognitoUserPoolsProcessor.java index 49c33b909..d8c2c205b 100644 --- a/cognito-user-pools/deployment/src/main/java/io/quarkus/amazon/cognitouserpools/deployment/CognitoUserPoolsProcessor.java +++ b/cognito-user-pools/deployment/src/main/java/io/quarkus/amazon/cognitouserpools/deployment/CognitoUserPoolsProcessor.java @@ -9,12 +9,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, + void setupApacheSyncTransport(List amazonClients, CognitoUserPoolsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -115,7 +124,8 @@ void setupApacheSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, CognitoUserPoolsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, + CognitoUserPoolsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -128,7 +138,7 @@ void setupAwsCrtSyncTransport(List amazonClients, Cognito @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, + void setupUrlConnectionSyncTransport(List amazonClients, CognitoUserPoolsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -142,7 +152,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, + void setupNettyAsyncTransport(List amazonClients, CognitoUserPoolsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, @@ -157,7 +167,8 @@ void setupNettyAsyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, CognitoUserPoolsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + CognitoUserPoolsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -173,6 +184,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Cognit void createClientBuilders(CognitoUserPoolsRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -187,6 +199,7 @@ void createClientBuilders(CognitoUserPoolsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsConfig.java b/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsConfig.java index fcfc108c4..788ebd50e 100644 --- a/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsConfig.java +++ b/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.cognitouserpools.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.cognito-user-pools") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface CognitoUserPoolsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface CognitoUserPoolsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsRecorder.java b/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsRecorder.java index db3341ab7..aa94d57c2 100644 --- a/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsRecorder.java +++ b/cognito-user-pools/runtime/src/main/java/io/quarkus/amazon/cognitouserpools/runtime/CognitoUserPoolsRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -21,13 +20,8 @@ public CognitoUserPoolsRecorder(CognitoUserPoolsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override 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 1ab242eb2..a834376e6 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 @@ -1,10 +1,17 @@ package io.quarkus.amazon.common.deployment; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.getNamedClientInjection; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.injectionPointAnnotationsBuilder; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.namedBuilder; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.namedClient; + +import java.util.Collection; import java.util.List; import java.util.Optional; import java.util.concurrent.ScheduledExecutorService; import java.util.function.Function; import java.util.function.Supplier; +import java.util.stream.Collectors; import jakarta.enterprise.context.ApplicationScoped; @@ -24,11 +31,10 @@ import io.quarkus.amazon.common.runtime.AmazonClientUrlConnectionTransportRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientBuildTimeConfig; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.HasSdkBuildTimeConfig; import io.quarkus.amazon.common.runtime.SdkAutoCloseableDestroyer; import io.quarkus.amazon.common.runtime.SdkBuildTimeConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientBuildTimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.arc.deployment.BeanRegistrationPhaseBuildItem; @@ -36,6 +42,7 @@ import io.quarkus.arc.processor.DotNames; import io.quarkus.arc.processor.InjectionPointInfo; import io.quarkus.deployment.annotations.BuildProducer; +import io.quarkus.deployment.annotations.BuildStep; import io.quarkus.deployment.builditem.ExecutorBuildItem; import io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem; import io.quarkus.deployment.builditem.FeatureBuildItem; @@ -62,24 +69,48 @@ protected DotName presignerClientName() { abstract protected String builtinInterceptorsPath(); - protected void discoverClient(BeanRegistrationPhaseBuildItem beanRegistrationPhase, - BuildProducer requireClientProducer) { - Optional syncClassName = Optional.empty(); - Optional asyncClassName = Optional.empty(); + protected void discoverClientInjectionPointsInternal(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { - // Discover all clients injections in order to determine if async or sync client - // is required + // Discover all clients injections for (InjectionPointInfo injectionPoint : beanRegistrationPhase.getInjectionPoints()) { Type injectedType = getInjectedType(injectionPoint); if (syncClientName().equals(injectedType.name())) { - syncClassName = Optional.of(syncClientName()); + requireClientInjectionProducer + .produce(new RequireAmazonClientInjectionBuildItem(syncClientName(), + getNamedClientInjection(injectionPoint))); } if (asyncClientName().equals(injectedType.name())) { + requireClientInjectionProducer + .produce(new RequireAmazonClientInjectionBuildItem(asyncClientName(), + getNamedClientInjection(injectionPoint))); + } + if (presignerClientName() != null && presignerClientName().equals(injectedType.name())) { + requireClientInjectionProducer + .produce(new RequireAmazonClientInjectionBuildItem(presignerClientName(), + getNamedClientInjection(injectionPoint))); + } + } + } + + @BuildStep + protected void discoverClient( + List amazonClientInjectionPoints, + BuildProducer requireClientProducer) { + Optional syncClassName = Optional.empty(); + Optional asyncClassName = Optional.empty(); + + for (RequireAmazonClientInjectionBuildItem requireInjectionPoint : amazonClientInjectionPoints) { + if (syncClientName().equals(requireInjectionPoint.getClassName())) { + syncClassName = Optional.of(syncClientName()); + } + if (asyncClientName().equals(requireInjectionPoint.getClassName())) { asyncClassName = Optional.of(asyncClientName()); } } + if (syncClassName.isPresent() || asyncClassName.isPresent()) { requireClientProducer.produce(new RequireAmazonClientBuildItem(syncClassName, asyncClassName)); } @@ -93,7 +124,7 @@ protected void discoverTelemetry(BuildProducer } protected void setupClient(List clientRequirements, - BuildProducer clientProducer, + BuildProducer clientProducer, SdkBuildTimeConfig buildTimeSdkConfig, SyncHttpClientBuildTimeConfig buildTimeSyncConfig, AsyncHttpClientBuildTimeConfig buildTimeAsyncConfig) { @@ -111,7 +142,7 @@ protected void setupClient(List clientRequirements } } if (syncClassName.isPresent() || asyncClassName.isPresent()) { - clientProducer.produce(new AmazonClientBuildItem(syncClassName, asyncClassName, configName(), + clientProducer.produce(new RequireAmazonClientTransportBuilderBuildItem(syncClassName, asyncClassName, configName(), buildTimeSdkConfig, buildTimeSyncConfig, buildTimeAsyncConfig)); } } @@ -126,13 +157,13 @@ protected void setupExtension( interceptors.produce(new AmazonClientInterceptorsPathBuildItem(builtinInterceptorsPath())); } - protected void createApacheSyncTransportBuilder(List amazonClients, + protected void createApacheSyncTransportBuilder(List amazonClients, AmazonClientApacheTransportRecorder recorder, SyncHttpClientBuildTimeConfig buildSyncConfig, RuntimeValue syncConfig, BuildProducer clientSyncTransports) { - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -152,13 +183,13 @@ protected void createApacheSyncTransportBuilder(List amaz }); } - protected void createAwsCrtSyncTransportBuilder(List amazonClients, + protected void createAwsCrtSyncTransportBuilder(List amazonClients, AmazonClientAwsCrtTransportRecorder recorder, SyncHttpClientBuildTimeConfig buildSyncConfig, RuntimeValue syncConfig, BuildProducer clientSyncTransports) { - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -178,13 +209,13 @@ protected void createAwsCrtSyncTransportBuilder(List amaz }); } - protected void createUrlConnectionSyncTransportBuilder(List amazonClients, + protected void createUrlConnectionSyncTransportBuilder(List amazonClients, AmazonClientUrlConnectionTransportRecorder recorder, SyncHttpClientBuildTimeConfig buildSyncConfig, RuntimeValue syncConfig, BuildProducer clientSyncTransports) { - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -204,14 +235,14 @@ protected void createUrlConnectionSyncTransportBuilder(List amazonClients, + protected void createNettyAsyncTransportBuilder(List amazonClients, AmazonClientNettyTransportRecorder recorder, AsyncHttpClientBuildTimeConfig buildAsyncConfig, RuntimeValue asyncConfig, BuildProducer clientAsyncTransports, Supplier eventLoopSupplier) { - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -232,13 +263,13 @@ protected void createNettyAsyncTransportBuilder(List amaz }); } - protected void createAwsCrtAsyncTransportBuilder(List amazonClients, + protected void createAwsCrtAsyncTransportBuilder(List amazonClients, AmazonClientAwsCrtTransportRecorder recorder, AsyncHttpClientBuildTimeConfig buildAsyncConfig, RuntimeValue asyncConfig, BuildProducer clientAsyncTransports) { - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -263,6 +294,7 @@ protected void createClientBuilders( AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, HasSdkBuildTimeConfig sdkBuildConfig, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -275,17 +307,17 @@ protected void createClientBuilders( LaunchModeBuildItem launchModeBuildItem, ExecutorBuildItem executorBuildItem) { - RuntimeValue presignerBuilder = null; + Supplier> presignerBuilderSupplier = null; if (presignerBuilderClass != null) { - presignerBuilder = recorder.createPresignerBuilder(); + presignerBuilderSupplier = () -> recorder.createPresignerBuilder(); } createClientBuilders( commonRecorder, otelRecorder, - recorder.getAwsConfig(), - recorder.getSdkConfig(), + recorder.getAmazonClientsConfig(), sdkBuildConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, @@ -295,7 +327,7 @@ protected void createClientBuilders( (asyncTransport) -> recorder.createAsyncBuilder(asyncTransport, launchModeBuildItem.getLaunchMode(), executorBuildItem.getExecutorProxy()), presignerBuilderClass, - presignerBuilder, + presignerBuilderSupplier, syntheticBeans, clientSync, clientAsync, @@ -306,9 +338,9 @@ protected void createClientBuilders( private void createClientBuilders( AmazonClientCommonRecorder recorder, AmazonClientOpenTelemetryRecorder otelRecorder, - RuntimeValue awsConfigRuntime, - RuntimeValue sdkConfigRuntime, + RuntimeValue amazonClientConfigRuntime, HasSdkBuildTimeConfig sdkBuildConfig, + List amazonClientInjections, List amazonRequireTelemtryClients, List amazonClientSyncTransports, List amazonClientAsyncTransports, @@ -317,7 +349,7 @@ private void createClientBuilders( Class asyncClientBuilderClass, Function, RuntimeValue> asyncClientBuilderFunction, Class presignerBuilderClass, - RuntimeValue presignerBuilder, + Supplier> presignerBuilderSupplier, BuildProducer syntheticBeans, BuildProducer clientSync, BuildProducer clientAsync, @@ -340,102 +372,136 @@ private void createClientBuilders( .anyMatch(c -> configName.equals(c.getConfigName())); if (!syncSdkHttpClientBuilder.isPresent() && !asyncSdkAsyncHttpClientBuilder.isPresent() - && presignerBuilder == null) { + && presignerBuilderSupplier == null) { return; } - RuntimeValue syncClientBuilder = syncSdkHttpClientBuilder.isPresent() - ? syncClientBuilderFunction.apply(syncSdkHttpClientBuilder.get()) - : null; - RuntimeValue asyncClientBuilder = asyncSdkAsyncHttpClientBuilder.isPresent() - ? asyncClientBuilderFunction.apply(asyncSdkAsyncHttpClientBuilder.get()) - : null; + // requiring named clients can originate from multiple sources and we may have duplicates + Collection syncClientNames = amazonClientInjections.stream() + .filter(c -> syncClientName().equals(c.getClassName())) + .map(c -> c.getName()) + .distinct() + .collect(Collectors.toSet()); + + Collection asyncClientNames = amazonClientInjections.stream() + .filter(c -> asyncClientName().equals(c.getClassName())) + .map(c -> c.getName()) + .distinct() + .collect(Collectors.toSet()); + + Collection presignerClientNames = amazonClientInjections.stream() + .filter(c -> presignerClientName() != null && presignerClientName().equals(c.getClassName())) + .map(c -> c.getName()) + .distinct() + .collect(Collectors.toSet()); ScheduledExecutorService sharedExecutorService = executorBuildItem.getExecutorProxy(); - if (syncClientBuilder != null) { - syncClientBuilder = recorder.configure(syncClientBuilder, awsConfigRuntime, sdkConfigRuntime, - sdkBuildConfig, sharedExecutorService, configName()); - if (addOpenTelemetry) { - syntheticBeans.produce(SyntheticBeanBuildItem - .configure(syncClientBuilderClass) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .createWith(otelRecorder.configureSync(syncClientBuilder)) - .addInjectionPoint(ClassType.create(AwsSdkTelemetry.class)).done()); - } else { - syntheticBeans.produce(SyntheticBeanBuildItem.configure(syncClientBuilderClass) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .runtimeValue(syncClientBuilder) - .done()); + if (syncSdkHttpClientBuilder.isPresent() && !syncClientNames.isEmpty()) { + for (String clientName : syncClientNames) { + RuntimeValue syncClientBuilder = syncClientBuilderFunction + .apply(syncSdkHttpClientBuilder.get()); + + syncClientBuilder = recorder.configure(syncClientBuilder, amazonClientConfigRuntime, + sdkBuildConfig, sharedExecutorService, configName(), clientName); + if (addOpenTelemetry) { + syntheticBeans.produce(namedBuilder(SyntheticBeanBuildItem.configure(syncClientBuilderClass), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .createWith(otelRecorder.configureSync(syncClientBuilder)) + .addInjectionPoint(ClassType.create(AwsSdkTelemetry.class)).done()); + } else { + syntheticBeans.produce(namedBuilder(SyntheticBeanBuildItem.configure(syncClientBuilderClass), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .runtimeValue(syncClientBuilder) + .done()); + } + syntheticBeans + .produce( + namedClient(SyntheticBeanBuildItem.configure(syncClientName()), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .createWith(recorder.build(syncClientBuilderClass, clientName)) + .addInjectionPoint(ClassType.create(syncClientBuilderClass), + injectionPointAnnotationsBuilder(clientName)) + .destroyer(SdkAutoCloseableDestroyer.class) + .done()); + + clientSync.produce(new AmazonClientSyncResultBuildItem(configName, clientName)); } - syntheticBeans.produce(SyntheticBeanBuildItem.configure(syncClientName()) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .createWith(recorder.build(syncClientBuilderClass)) - .addInjectionPoint(ClassType.create(syncClientBuilderClass)) - .destroyer(SdkAutoCloseableDestroyer.class) - .done()); - clientSync.produce(new AmazonClientSyncResultBuildItem(configName)); } - if (asyncClientBuilder != null) { - asyncClientBuilder = recorder.configure(asyncClientBuilder, awsConfigRuntime, sdkConfigRuntime, - sdkBuildConfig, sharedExecutorService, configName()); - if (addOpenTelemetry) { - syntheticBeans.produce(SyntheticBeanBuildItem - .configure(asyncClientBuilderClass) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .createWith(otelRecorder.configureAsync(asyncClientBuilder)) - .addInjectionPoint(ClassType.create(AwsSdkTelemetry.class)).done()); - } else { - syntheticBeans.produce(SyntheticBeanBuildItem.configure(asyncClientBuilderClass) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .runtimeValue(asyncClientBuilder) - .done()); + if (asyncSdkAsyncHttpClientBuilder.isPresent() && !asyncClientNames.isEmpty()) { + for (String clientName : asyncClientNames) { + RuntimeValue asyncClientBuilder = asyncClientBuilderFunction + .apply(asyncSdkAsyncHttpClientBuilder.get()); + + asyncClientBuilder = recorder.configure(asyncClientBuilder, amazonClientConfigRuntime, + sdkBuildConfig, sharedExecutorService, configName(), clientName); + if (addOpenTelemetry) { + syntheticBeans.produce(namedBuilder(SyntheticBeanBuildItem.configure(asyncClientBuilderClass), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .createWith(otelRecorder.configureAsync(asyncClientBuilder)) + .addInjectionPoint(ClassType.create(AwsSdkTelemetry.class)).done()); + } else { + syntheticBeans.produce(namedBuilder(SyntheticBeanBuildItem.configure(asyncClientBuilderClass), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .runtimeValue(asyncClientBuilder) + .done()); + } + syntheticBeans.produce( + namedClient(SyntheticBeanBuildItem.configure(asyncClientName()), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .createWith(recorder.build(asyncClientBuilderClass, clientName)) + .addInjectionPoint(ClassType.create(asyncClientBuilderClass), + injectionPointAnnotationsBuilder(clientName)) + .destroyer(SdkAutoCloseableDestroyer.class) + .done()); + + clientAsync.produce(new AmazonClientAsyncResultBuildItem(configName, clientName)); } - syntheticBeans.produce(SyntheticBeanBuildItem.configure(asyncClientName()) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .createWith(recorder.build(asyncClientBuilderClass)) - .addInjectionPoint(ClassType.create(asyncClientBuilderClass)) - .destroyer(SdkAutoCloseableDestroyer.class) - .done()); - clientAsync.produce(new AmazonClientAsyncResultBuildItem(configName)); } - if (presignerBuilder != null) { - presignerBuilder = recorder.configurePresigner(presignerBuilder, awsConfigRuntime, sdkConfigRuntime, - configName()); - syntheticBeans.produce(SyntheticBeanBuildItem.configure(presignerBuilderClass) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .runtimeValue(presignerBuilder) - .done()); - syntheticBeans.produce(SyntheticBeanBuildItem.configure(presignerClientName()) - .unremovable() - .defaultBean() - .setRuntimeInit() - .scope(ApplicationScoped.class) - .createWith(recorder.build(presignerBuilderClass)) - .addInjectionPoint(ClassType.create(presignerBuilderClass)) - .destroyer(SdkAutoCloseableDestroyer.class) - .done()); + if (presignerBuilderSupplier != null && !presignerClientNames.isEmpty()) { + for (String clientName : presignerClientNames) { + RuntimeValue presignerBuilder = presignerBuilderSupplier.get(); + + presignerBuilder = recorder.configurePresigner(presignerBuilder, amazonClientConfigRuntime, + configName(), clientName); + syntheticBeans.produce( + namedBuilder(SyntheticBeanBuildItem.configure(presignerBuilderClass), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .runtimeValue(presignerBuilder) + .done()); + syntheticBeans.produce( + namedClient(SyntheticBeanBuildItem.configure(presignerClientName()), clientName) + .unremovable() + .defaultBean() + .setRuntimeInit() + .scope(ApplicationScoped.class) + .createWith(recorder.buildPresigner(presignerBuilderClass, clientName)) + .addInjectionPoint(ClassType.create(presignerBuilderClass), + injectionPointAnnotationsBuilder(clientName)) + .destroyer(SdkAutoCloseableDestroyer.class) + .done()); + } } } diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientAsyncResultBuildItem.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientAsyncResultBuildItem.java index 1ebbdb8c8..95397c50b 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientAsyncResultBuildItem.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientAsyncResultBuildItem.java @@ -8,12 +8,18 @@ public final class AmazonClientAsyncResultBuildItem extends MultiBuildItem { private final String awsClientName; + private String clientName; - public AmazonClientAsyncResultBuildItem(String awsClientName) { + public AmazonClientAsyncResultBuildItem(String awsClientName, String clientName) { this.awsClientName = awsClientName; + this.clientName = clientName; } public String getAwsClientName() { return awsClientName; } + + public String getClientName() { + return clientName; + } } diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientSyncResultBuildItem.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientSyncResultBuildItem.java index 2f2305f70..5b53d677e 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientSyncResultBuildItem.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientSyncResultBuildItem.java @@ -8,12 +8,18 @@ public final class AmazonClientSyncResultBuildItem extends MultiBuildItem { private final String awsClientName; + private String clientName; - public AmazonClientSyncResultBuildItem(String awsClientName) { + public AmazonClientSyncResultBuildItem(String awsClientName, String clientName) { this.awsClientName = awsClientName; + this.clientName = clientName; } public String getAwsClientName() { return awsClientName; } + + public String getClientName() { + return clientName; + } } diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java index f7e182d7a..09fcf9ac7 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonServicesClientsProcessor.java @@ -10,6 +10,8 @@ import org.jboss.jandex.DotName; import org.jboss.jandex.Type; +import io.quarkus.amazon.common.AmazonClient; +import io.quarkus.amazon.common.AmazonClientBuilder; import io.quarkus.amazon.common.runtime.AsyncHttpClientBuildTimeConfig.AsyncClientType; import io.quarkus.amazon.common.runtime.AwsSdkTelemetryProducer; import io.quarkus.amazon.common.runtime.SdkBuildTimeConfig; @@ -39,6 +41,11 @@ public class AmazonServicesClientsProcessor { private static final DotName EXECUTION_INTERCEPTOR_NAME = DotName.createSimple(ExecutionInterceptor.class.getName()); + @BuildStep + AdditionalBeanBuildItem additionalBeans() { + return new AdditionalBeanBuildItem(AmazonClient.class, AmazonClientBuilder.class); + } + @BuildStep void globalInterceptors(BuildProducer producer) { producer.produce( @@ -55,7 +62,7 @@ void awsAppArchiveMarkers(BuildProducer interceptors, BuildProducer resource, CombinedIndexBuildItem combinedIndexBuildItem, - List amazonClients, + List amazonClients, BuildProducer reflectiveClasses, BuildProducer unremovables) { @@ -69,7 +76,7 @@ void setupInterceptors(List interceptors, .map(c -> c.name().toString()).collect(Collectors.toList()); //Validate configurations - for (AmazonClientBuildItem client : amazonClients) { + for (RequireAmazonClientTransportBuilderBuildItem client : amazonClients) { SdkBuildTimeConfig clientSdkConfig = client.getBuildTimeSdkConfig(); if (clientSdkConfig != null) { clientSdkConfig.interceptors().orElse(Collections.emptyList()).forEach(interceptorClassName -> { @@ -125,7 +132,7 @@ void setupTelemetry(List items, @BuildStep void setup( - List amazonClients, + List amazonClients, BuildProducer reflectiveClasses, BuildProducer proxyDefinition, BuildProducer serviceProvider) { @@ -136,11 +143,11 @@ void setup( boolean syncTransportNeeded = amazonClients.stream().anyMatch(item -> item.getSyncClassName().isPresent()); boolean asyncTransportNeeded = amazonClients.stream().anyMatch(item -> item.getAsyncClassName().isPresent()); - final Predicate isSyncApache = client -> client + final Predicate isSyncApache = client -> client .getBuildTimeSyncConfig().type() == SyncClientType.APACHE; - final Predicate isSyncCrt = client -> client + final Predicate isSyncCrt = client -> client .getBuildTimeSyncConfig().type() == SyncClientType.AWS_CRT; - final Predicate isAsyncNetty = client -> client + final Predicate isAsyncNetty = client -> client .getBuildTimeAsyncConfig().type() == AsyncClientType.NETTY; // Register what's needed depending on the clients in the classpath and the configuration. diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/ClientDeploymentUtil.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/ClientDeploymentUtil.java new file mode 100644 index 000000000..2ea004a6e --- /dev/null +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/ClientDeploymentUtil.java @@ -0,0 +1,66 @@ +package io.quarkus.amazon.common.deployment; + +import org.jboss.jandex.AnnotationInstance; +import org.jboss.jandex.DotName; + +import io.quarkus.amazon.common.runtime.ClientUtil; +import io.quarkus.arc.deployment.SyntheticBeanBuildItem.ExtendedBeanConfigurator; +import io.quarkus.arc.processor.DotNames; +import io.quarkus.arc.processor.InjectionPointInfo; + +public final class ClientDeploymentUtil { + + private static final DotName AWS_CLIENT_NAME = DotName.createSimple(io.quarkus.amazon.common.AmazonClient.class.getName()); + private static final DotName AWS_CLIENT_BUILDER_NAME = DotName + .createSimple(io.quarkus.amazon.common.AmazonClientBuilder.class.getName()); + private static final AnnotationInstance[] EMPTY_ANNOTATIONS = new AnnotationInstance[0]; + + private ClientDeploymentUtil() { + } + + public static String getNamedClientInjection(InjectionPointInfo injectionPoint) { + var named = injectionPoint.getRequiredQualifier(AWS_CLIENT_NAME); + if (named != null) { + return named.value("value").asString(); + } else { + return ClientUtil.DEFAULT_CLIENT_NAME; + } + } + + public static ExtendedBeanConfigurator namedClient(ExtendedBeanConfigurator beanConfigurator, String clientName) { + return named(beanConfigurator, AWS_CLIENT_NAME, clientName); + } + + public static ExtendedBeanConfigurator namedBuilder(ExtendedBeanConfigurator beanConfigurator, String clientName) { + return named(beanConfigurator, AWS_CLIENT_BUILDER_NAME, clientName); + } + + public static AnnotationInstance[] injectionPointAnnotationsClient(String clientName) { + return injectionPointAnnotations(AWS_CLIENT_NAME, clientName); + } + + public static AnnotationInstance[] injectionPointAnnotationsBuilder(String clientName) { + return injectionPointAnnotations(AWS_CLIENT_BUILDER_NAME, clientName); + } + + private static ExtendedBeanConfigurator named(ExtendedBeanConfigurator beanConfigurator, DotName annotationName, + String clientName) { + if (ClientUtil.isDefaultClient(clientName)) { + beanConfigurator.addQualifier(DotNames.DEFAULT); + } else { + beanConfigurator.addQualifier().annotation(annotationName).addValue("value", clientName).done(); + } + + return beanConfigurator; + } + + private static AnnotationInstance[] injectionPointAnnotations(DotName annotationName, String clientName) { + if (ClientUtil.isDefaultClient(clientName)) { + return EMPTY_ANNOTATIONS; + } else { + return new AnnotationInstance[] { + AnnotationInstance.builder(annotationName).add("value", clientName).build() + }; + } + } +} diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientInjectionBuildItem.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientInjectionBuildItem.java new file mode 100644 index 000000000..2d73b9f0e --- /dev/null +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientInjectionBuildItem.java @@ -0,0 +1,27 @@ +package io.quarkus.amazon.common.deployment; + +import org.jboss.jandex.DotName; + +import io.quarkus.builder.item.MultiBuildItem; + +/** + * Describes what client names are required. + * + */ +public final class RequireAmazonClientInjectionBuildItem extends MultiBuildItem { + private final DotName className; + private final String name; + + public RequireAmazonClientInjectionBuildItem(DotName className, String name) { + this.className = className; + this.name = name; + } + + public DotName getClassName() { + return className; + } + + public String getName() { + return name; + } +} diff --git a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientBuildItem.java b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientTransportBuilderBuildItem.java similarity index 86% rename from common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientBuildItem.java rename to common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientTransportBuilderBuildItem.java index d2f2189ea..dcaee88ac 100644 --- a/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/AmazonClientBuildItem.java +++ b/common/deployment/src/main/java/io/quarkus/amazon/common/deployment/RequireAmazonClientTransportBuilderBuildItem.java @@ -10,9 +10,9 @@ import io.quarkus.builder.item.MultiBuildItem; /** - * Describes what clients are required for a given extension + * Describes what client transport builders are required for a given extension */ -public final class AmazonClientBuildItem extends MultiBuildItem { +public final class RequireAmazonClientTransportBuilderBuildItem extends MultiBuildItem { private final Optional syncClassName; private final Optional asyncClassName; private final String awsClientName; @@ -20,7 +20,7 @@ public final class AmazonClientBuildItem extends MultiBuildItem { private final SyncHttpClientBuildTimeConfig buildTimeSyncConfig; private final AsyncHttpClientBuildTimeConfig buildTimeAsyncConfig; - public AmazonClientBuildItem(Optional syncClassName, Optional asyncClassName, + public RequireAmazonClientTransportBuilderBuildItem(Optional syncClassName, Optional asyncClassName, String awsClientName, SdkBuildTimeConfig buildTimeSdkConfig, SyncHttpClientBuildTimeConfig buildTimeSyncConfig, AsyncHttpClientBuildTimeConfig buildTimeAsyncConfig) { diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClient.java b/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClient.java new file mode 100644 index 000000000..a5710b81e --- /dev/null +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClient.java @@ -0,0 +1,40 @@ +package io.quarkus.amazon.common; + +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.METHOD; +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import jakarta.enterprise.util.AnnotationLiteral; +import jakarta.inject.Qualifier; + +/** + * Qualifier used to specify which aws client will be injected. + */ +@Target({ METHOD, FIELD, PARAMETER, TYPE }) +@Retention(RUNTIME) +@Documented +@Qualifier +public @interface AmazonClient { + + String value(); + + public class AmazonClientLiteral extends AnnotationLiteral implements AmazonClient { + + private String name; + + public AmazonClientLiteral(String name) { + this.name = name; + } + + @Override + public String value() { + return name; + } + } +} \ No newline at end of file diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClientBuilder.java b/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClientBuilder.java new file mode 100644 index 000000000..0c2830ce4 --- /dev/null +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/AmazonClientBuilder.java @@ -0,0 +1,40 @@ +package io.quarkus.amazon.common; + +import static java.lang.annotation.ElementType.FIELD; +import static java.lang.annotation.ElementType.METHOD; +import static java.lang.annotation.ElementType.PARAMETER; +import static java.lang.annotation.ElementType.TYPE; +import static java.lang.annotation.RetentionPolicy.RUNTIME; + +import java.lang.annotation.Documented; +import java.lang.annotation.Retention; +import java.lang.annotation.Target; + +import jakarta.enterprise.util.AnnotationLiteral; +import jakarta.inject.Qualifier; + +/** + * Qualifier used to specify which aws client builder will be injected. + */ +@Target({ METHOD, FIELD, PARAMETER, TYPE }) +@Retention(RUNTIME) +@Documented +@Qualifier +public @interface AmazonClientBuilder { + + String value(); + + public class AmazonClientBuilderLiteral extends AnnotationLiteral implements AmazonClientBuilder { + + private String name; + + public AmazonClientBuilderLiteral(String name) { + this.name = name; + } + + @Override + public String value() { + return name; + } + } +} \ No newline at end of file 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 2d22a5bfe..36565c65e 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 @@ -16,6 +16,8 @@ import io.quarkus.arc.SyntheticCreationalContext; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; import software.amazon.awssdk.awscore.AwsClient; import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder; import software.amazon.awssdk.awscore.presigner.SdkPresigner; @@ -30,45 +32,57 @@ public class AmazonClientCommonRecorder { private static final Log LOG = LogFactory.getLog(AmazonClientCommonRecorder.class); public RuntimeValue configure(RuntimeValue clientBuilder, - RuntimeValue awsConfig, RuntimeValue sdkConfig, HasSdkBuildTimeConfig sdkBuildTimeConfig, - ScheduledExecutorService scheduledExecutorService, String awsServiceName) { + RuntimeValue amazonClientConfigRuntime, HasSdkBuildTimeConfig sdkBuildTimeConfig, + ScheduledExecutorService scheduledExecutorService, String awsServiceName, String clientName) { AwsClientBuilder builder = clientBuilder.getValue(); - initAwsClient(builder, awsServiceName, awsConfig.getValue()); - initSdkClient(builder, awsServiceName, sdkConfig.getValue(), sdkBuildTimeConfig.sdk(), scheduledExecutorService); + AmazonClientConfig namedConfig = amazonClientConfigRuntime.getValue().clients().get(clientName); + AmazonClientConfig defaultConfig = amazonClientConfigRuntime.getValue().clients().get(ClientUtil.DEFAULT_CLIENT_NAME); + + String namedExtension = ClientUtil.isDefaultClient(clientName) ? awsServiceName : awsServiceName + "." + clientName; + initAwsClient(builder, awsServiceName, namedExtension, namedConfig.aws(), defaultConfig.aws()); + initSdkClient(builder, awsServiceName, namedExtension, namedConfig.sdk(), defaultConfig.sdk(), sdkBuildTimeConfig.sdk(), + scheduledExecutorService); return new RuntimeValue<>(builder); } - public void initAwsClient(AwsClientBuilder builder, String extension, AwsConfig config) { - config.region().ifPresent(builder::region); + public void initAwsClient(AwsClientBuilder builder, String extension, String namedExtension, AwsConfig namedConfig, + AwsConfig defaultConfig) { + namedConfig.region().or(() -> defaultConfig.region()).ifPresent(builder::region); + + AwsCredentialsProvider credential = namedConfig.credentials().map(c -> c.type().create(c, "quarkus." + namedExtension)) + .or(() -> defaultConfig.credentials().map(c -> c.type().create(c, "quarkus." + extension))) + .orElseGet(() -> DefaultCredentialsProvider.builder().asyncCredentialUpdateEnabled(false) + .reuseLastProviderEnabled(false).build()); - builder.credentialsProvider(config.credentials().type().create(config.credentials(), "quarkus." + extension)); + builder.credentialsProvider(credential); } - public void initSdkClient(SdkClientBuilder builder, String extension, SdkConfig config, SdkBuildTimeConfig buildConfig, + public void initSdkClient(SdkClientBuilder builder, String extension, String namedExtension, SdkConfig namedConfig, + SdkConfig defaultConfig, SdkBuildTimeConfig buildConfig, ScheduledExecutorService scheduledExecutorService) { - if (config.endpointOverride().isPresent()) { - URI endpointOverride = config.endpointOverride().get(); - if (StringUtils.isBlank(endpointOverride.getScheme())) { - throw new RuntimeConfigurationError( - String.format("quarkus.%s.endpoint-override (%s) - scheme must be specified", - extension, - endpointOverride.toString())); - } + + if (namedConfig.endpointOverride().isPresent()) { + validEndpointOverride(namedExtension, namedConfig.endpointOverride().get()); + } else if (defaultConfig.endpointOverride().isPresent()) { + validEndpointOverride(extension, defaultConfig.endpointOverride().get()); } - config.endpointOverride().filter(URI::isAbsolute).ifPresent(builder::endpointOverride); + namedConfig.endpointOverride().filter(URI::isAbsolute) + .or(() -> defaultConfig.endpointOverride().filter(URI::isAbsolute)).ifPresent(builder::endpointOverride); final ClientOverrideConfiguration.Builder overrides = ClientOverrideConfiguration.builder(); - if (config.advanced().useQuarkusScheduledExecutorService()) { + if (namedConfig.advanced().useQuarkusScheduledExecutorService() + .or(() -> defaultConfig.advanced().useQuarkusScheduledExecutorService()).orElse(true)) { // use quarkus executor service overrides.scheduledExecutorService(scheduledExecutorService); } - config.apiCallTimeout().ifPresent(overrides::apiCallTimeout); - config.apiCallAttemptTimeout().ifPresent(overrides::apiCallAttemptTimeout); + namedConfig.apiCallTimeout().or(() -> defaultConfig.apiCallTimeout()).ifPresent(overrides::apiCallTimeout); + namedConfig.apiCallAttemptTimeout().or(() -> defaultConfig.apiCallAttemptTimeout()) + .ifPresent(overrides::apiCallAttemptTimeout); buildConfig.interceptors().orElse(Collections.emptyList()).stream() .map(String::trim) @@ -78,36 +92,53 @@ public void initSdkClient(SdkClientBuilder builder, String extension, SdkConfig builder.overrideConfiguration(overrides.build()); } + private void validEndpointOverride(String namedExtension, URI endpointOverride) { + if (StringUtils.isBlank(endpointOverride.getScheme())) { + throw new RuntimeConfigurationError( + String.format("quarkus.%s.endpoint-override (%s) - scheme must be specified", + namedExtension, + endpointOverride.toString())); + } + } + public RuntimeValue configurePresigner( RuntimeValue clientBuilder, - RuntimeValue awsConfig, RuntimeValue sdkConfig, - String awsServiceName) { + RuntimeValue amazonClientConfigRuntime, + String awsServiceName, String clientName) { SdkPresigner.Builder builder = clientBuilder.getValue(); - initAwsPresigner(builder, awsServiceName, awsConfig.getValue()); - initSdkPresigner(builder, awsServiceName, sdkConfig.getValue()); + AmazonClientConfig namedConfig = amazonClientConfigRuntime.getValue().clients().get(clientName); + AmazonClientConfig defaultConfig = amazonClientConfigRuntime.getValue().clients().get(ClientUtil.DEFAULT_CLIENT_NAME); + + String namedExtension = ClientUtil.isDefaultClient(clientName) ? awsServiceName : awsServiceName + "." + clientName; + initAwsPresigner(builder, awsServiceName, namedExtension, namedConfig.aws(), defaultConfig.aws()); + initSdkPresigner(builder, awsServiceName, namedExtension, namedConfig.sdk(), defaultConfig.sdk()); return new RuntimeValue<>(builder); } - public void initAwsPresigner(SdkPresigner.Builder builder, String extension, AwsConfig config) { - config.region().ifPresent(builder::region); + public void initAwsPresigner(SdkPresigner.Builder builder, String extension, String namedExtension, AwsConfig namedConfig, + AwsConfig defaultConfig) { + namedConfig.region().or(() -> defaultConfig.region()).ifPresent(builder::region); - builder.credentialsProvider(config.credentials().type().create(config.credentials(), "quarkus." + extension)); + AwsCredentialsProvider credential = namedConfig.credentials().map(c -> c.type().create(c, "quarkus." + namedExtension)) + .or(() -> defaultConfig.credentials().map(c -> c.type().create(c, "quarkus." + extension))) + .orElseGet(() -> DefaultCredentialsProvider.builder().asyncCredentialUpdateEnabled(false) + .reuseLastProviderEnabled(false).build()); + + builder.credentialsProvider(credential); } - public void initSdkPresigner(SdkPresigner.Builder builder, String extension, SdkConfig config) { - if (config.endpointOverride().isPresent()) { - URI endpointOverride = config.endpointOverride().get(); - if (StringUtils.isBlank(endpointOverride.getScheme())) { - throw new RuntimeConfigurationError( - String.format("quarkus.%s.endpoint-override (%s) - scheme must be specified", - extension, - endpointOverride.toString())); - } + public void initSdkPresigner(SdkPresigner.Builder builder, String extension, String namedExtension, SdkConfig namedConfig, + SdkConfig defaultConfig) { + if (namedConfig.endpointOverride().isPresent()) { + validEndpointOverride(namedExtension, namedConfig.endpointOverride().get()); + } else if (defaultConfig.endpointOverride().isPresent()) { + validEndpointOverride(extension, defaultConfig.endpointOverride().get()); } - config.endpointOverride().filter(URI::isAbsolute).ifPresent(builder::endpointOverride); + namedConfig.endpointOverride().filter(URI::isAbsolute) + .or(() -> defaultConfig.endpointOverride().filter(URI::isAbsolute)).ifPresent(builder::endpointOverride); } private ExecutionInterceptor createInterceptor(String interceptorClassName) { @@ -127,15 +158,37 @@ private ExecutionInterceptor createInterceptor(String interceptorClassName) { } } - public Function, AwsClient> build(Class clazz) { + public Function, AwsClient> build(Class clazz, String clientName) { return new Function, AwsClient>() { @Override public AwsClient apply(SyntheticCreationalContext context) { - SdkBuilder builder = (SdkBuilder) context.getInjectedReference(clazz); + SdkBuilder builder; + if (ClientUtil.isDefaultClient(clientName)) + builder = (SdkBuilder) context.getInjectedReference(clazz); + else + builder = (SdkBuilder) context.getInjectedReference(clazz, + new io.quarkus.amazon.common.AmazonClientBuilder.AmazonClientBuilderLiteral(clientName)); return (AwsClient) builder.build(); } }; } + + public Function, SdkPresigner> buildPresigner(Class clazz, String clientName) { + return new Function, SdkPresigner>() { + + @Override + public SdkPresigner apply(SyntheticCreationalContext context) { + SdkPresigner.Builder builder; + if (ClientUtil.isDefaultClient(clientName)) + builder = (SdkPresigner.Builder) context.getInjectedReference(clazz); + else + builder = (SdkPresigner.Builder) context.getInjectedReference(clazz, + new io.quarkus.amazon.common.AmazonClientBuilder.AmazonClientBuilderLiteral(clientName)); + + return (SdkPresigner) builder.build(); + } + }; + } } diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientConfig.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientConfig.java new file mode 100644 index 000000000..cd1bea4f9 --- /dev/null +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientConfig.java @@ -0,0 +1,21 @@ +package io.quarkus.amazon.common.runtime; + +import io.quarkus.runtime.annotations.ConfigDocSection; +import io.quarkus.runtime.annotations.ConfigGroup; +import io.smallrye.config.WithParentName; + +@ConfigGroup +public interface AmazonClientConfig { + /** + * AWS SDK client configurations + */ + @WithParentName + @ConfigDocSection + SdkConfig sdk(); + + /** + * AWS services configurations + */ + @ConfigDocSection + AwsConfig aws(); +} diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientRecorder.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientRecorder.java index 787d8bbd3..6d170e5eb 100644 --- a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientRecorder.java +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AmazonClientRecorder.java @@ -14,9 +14,7 @@ public abstract class AmazonClientRecorder { - public abstract RuntimeValue getAwsConfig(); - - public abstract RuntimeValue getSdkConfig(); + public abstract RuntimeValue getAmazonClientsConfig(); public abstract AsyncHttpClientConfig getAsyncClientConfig(); @@ -40,6 +38,7 @@ public RuntimeValue createSyncBuilder(RuntimeValue tr if (transport != null) { builder.httpClientBuilder(transport.getValue()); } + return new RuntimeValue<>((AwsClientBuilder) builder); } diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AwsConfig.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AwsConfig.java index 55da1dcb3..c3bffde51 100644 --- a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AwsConfig.java +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/AwsConfig.java @@ -31,6 +31,6 @@ public interface AwsConfig { /** * Defines credentials provider used */ - AwsCredentialsProviderConfig credentials(); + Optional credentials(); } diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/ClientUtil.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/ClientUtil.java new file mode 100644 index 000000000..c229c9751 --- /dev/null +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/ClientUtil.java @@ -0,0 +1,9 @@ +package io.quarkus.amazon.common.runtime; + +public final class ClientUtil { + public static final String DEFAULT_CLIENT_NAME = ""; + + public static boolean isDefaultClient(String clientName) { + return DEFAULT_CLIENT_NAME.equalsIgnoreCase(clientName); + } +} diff --git a/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/HasAmazonClientRuntimeConfig.java b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/HasAmazonClientRuntimeConfig.java new file mode 100644 index 000000000..064eb2bd0 --- /dev/null +++ b/common/runtime/src/main/java/io/quarkus/amazon/common/runtime/HasAmazonClientRuntimeConfig.java @@ -0,0 +1,20 @@ +package io.quarkus.amazon.common.runtime; + +import java.util.Map; + +import io.quarkus.runtime.annotations.ConfigDocMapKey; +import io.smallrye.config.WithDefaults; +import io.smallrye.config.WithParentName; +import io.smallrye.config.WithUnnamedKey; + +public interface HasAmazonClientRuntimeConfig { + + /** + * Clients + */ + @ConfigDocMapKey("client-name") + @WithParentName + @WithDefaults + @WithUnnamedKey(ClientUtil.DEFAULT_CLIENT_NAME) + Map clients(); +} 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 8bfe91657..77cdb9394 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 @@ -4,10 +4,10 @@ import java.time.Duration; import java.util.Optional; +import io.quarkus.runtime.annotations.ConfigDocDefault; 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 @@ -58,7 +58,7 @@ public interface Advanced { * 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(); + @ConfigDocDefault("true") + Optional useQuarkusScheduledExecutorService(); } } diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 2477723a2..01890cfba 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1,4 +1,3 @@ -* xref:index.adoc[Quarkus Amazon Services] * xref:amazon-cloudwatch.adoc[CloudWatch] * xref:amazon-cloudwatchlogs.adoc[CloudWatch Logs] * xref:amazon-cognitouserpools.adoc[Cognito User Pools] @@ -21,3 +20,5 @@ * xref:amazon-sts.adoc[STS] * xref:dev-services.adoc[Dev Services for Amazon Services] * xref:opentelemetry.adoc[OpenTelemetry for Amazon Services] +* xref:common-features.adoc[Common features] + diff --git a/docs/modules/ROOT/pages/amazon-cognitouserpools.adoc b/docs/modules/ROOT/pages/amazon-cognitouserpools.adoc index c959a3000..0ef4ea341 100644 --- a/docs/modules/ROOT/pages/amazon-cognitouserpools.adoc +++ b/docs/modules/ROOT/pages/amazon-cognitouserpools.adoc @@ -303,4 +303,4 @@ And add the following dependency to the application `pom.xml`: == Configuration Reference -include::./includes/quarkus-amazon-cognitouserpools.adoc[] +include::./includes/quarkus-amazon-cognito-user-pools.adoc[] diff --git a/docs/modules/ROOT/pages/amazon-s3.adoc b/docs/modules/ROOT/pages/amazon-s3.adoc index 9234587c2..d19453f32 100644 --- a/docs/modules/ROOT/pages/amazon-s3.adoc +++ b/docs/modules/ROOT/pages/amazon-s3.adoc @@ -563,7 +563,7 @@ S3 Transfer Manager and the Quarkus extension supports only https://docs.aws.ama S3 Transfer Manager share the same configuration as S3 asynchronous client. See above to configure an `S3AsyncClient`. -If you want to use S3 Transfer Manager, configure an `S3AsyncClient`with the desired HTTP client library and simply inject an instance of `S3TransferManager`: +If you want to use S3 Transfer Manager, configure an `S3AsyncClient` with the desired HTTP client library and simply inject an instance of `S3TransferManager`: [source,java] ---- // Netty or AWS CRT-based HTTP client @@ -585,8 +585,6 @@ And add the following dependency to the application `pom.xml`: ---- -You can then make call - == Configuration Reference include::./includes/quarkus-amazon-s3.adoc[] diff --git a/docs/modules/ROOT/pages/common-features.adoc b/docs/modules/ROOT/pages/common-features.adoc new file mode 100644 index 000000000..649c57cbb --- /dev/null +++ b/docs/modules/ROOT/pages/common-features.adoc @@ -0,0 +1,29 @@ += Common features + +== Named clients + +NOTE: This feature is new and was initially designed to allow overriding credentials per named client. Feel free to open an issue to propose enhancements. + +You can inject named clients with different configurations. To do this, annotate your injection point with `@AmazonClient`. + +[source,java] +---- +import io.quarkus.amazon.common.AmazonClient; + +public class DynamoDbEnhancedClientTest { + + @Inject + @AmazonClient("custom") + DynamoDbClient clientNamedCustom; + +---- + +Named clients inherit the configuration of the unamed client but you can override them. + +[source,properties] +---- +quarkus.dynamodb.custom.aws.credentials.type=static +quarkus.dynamodb.custom.aws.credentials.static-provider.access-key-id=xxx +quarkus.dynamodb.custom.aws.credentials.static-provider.secret-access-key=yyy +---- + diff --git a/docs/modules/ROOT/pages/dev-services.adoc b/docs/modules/ROOT/pages/dev-services.adoc index c5cc3e8f6..c54d6278d 100644 --- a/docs/modules/ROOT/pages/dev-services.adoc +++ b/docs/modules/ROOT/pages/dev-services.adoc @@ -81,10 +81,4 @@ quarkus.aws.devservices.moto.container-properties.MOTO_COGNITO_IDP_USER_POOL_ID_ == Global DevServices Configuration Reference -=== LocalStack Configuration - -include::./includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc[] - -=== Moto Configuration - -include::./includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc[] +include::./includes/quarkus-amazon_quarkus.aws.adoc[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch.adoc index 3ca3c8c35..8d9381958 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-cloudwatch +:summaryTableId: quarkus-amazon-cloudwatch_quarkus-cloudwatch [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-cloudwatch_configuration]]link:#quarkus-amazon-cloudwatch_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-interceptors]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-interceptors[quarkus.cloudwatch.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-interceptors]] [.property-path]##`quarkus.cloudwatch.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-telemetry-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-telemetry-enabled[quarkus.cloudwatch.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-telemetry-enabled]] [.property-path]##`quarkus.cloudwatch.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-type[quarkus.cloudwatch.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-type]] [.property-path]##`quarkus.cloudwatch.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-type[quarkus.cloudwatch.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-type]] [.property-path]##`quarkus.cloudwatch.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-enabled[quarkus.cloudwatch.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-enabled]] [.property-path]##`quarkus.cloudwatch.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-shared]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-shared[quarkus.cloudwatch.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-shared]] [.property-path]##`quarkus.cloudwatch.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-isolated]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-isolated[quarkus.cloudwatch.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-isolated]] [.property-path]##`quarkus.cloudwatch.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-service-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-service-name[quarkus.cloudwatch.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-service-name]] [.property-path]##`quarkus.cloudwatch.devservices.service-name`## [.description] -- @@ -146,2653 +141,1021 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-container-properties-container-properties]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-container-properties-container-properties[quarkus.cloudwatch.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cloudwatch.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-interceptors]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-interceptors[quarkus.cloudwatchlogs.interceptors]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-endpoint-override]] [.property-path]##`quarkus.cloudwatch.endpoint-override`## +`quarkus.cloudwatch."client-name".endpoint-override` [.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. +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. -The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-timeout]] [.property-path]##`quarkus.cloudwatch.api-call-timeout`## -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-telemetry-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-telemetry-enabled[quarkus.cloudwatchlogs.telemetry.enabled]` - +`quarkus.cloudwatch."client-name".api-call-timeout` [.description] -- -OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - +The amount of time to allow the client to complete the execution of an API call. -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-type[quarkus.cloudwatchlogs.sync-client.type]` +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. +This value should always be positive, if present. -[.description] --- -Type of the sync HTTP client implementation ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` -|`url` - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-type[quarkus.cloudwatchlogs.async-client.type]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-attempt-timeout]] [.property-path]##`quarkus.cloudwatch.api-call-attempt-timeout`## +`quarkus.cloudwatch."client-name".api-call-attempt-timeout` [.description] -- -Type of the async HTTP client implementation +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` -|`netty` - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-enabled[quarkus.cloudwatchlogs.devservices.enabled]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cloudwatch.advanced.use-quarkus-scheduled-executor-service`## +`quarkus.cloudwatch."client-name".advanced.use-quarkus-scheduled-executor-service` [.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 +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_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean -| +-- +|boolean +|`true` + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-shared]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-shared[quarkus.cloudwatchlogs.devservices.shared]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-region]] [.property-path]##`quarkus.cloudwatch.aws.region`## +`quarkus.cloudwatch."client-name".aws.region` [.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. +An Amazon Web Services region that hosts the given service. -The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. -Sharing is not supported for the Cognito extension. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - +-- +|Region +| -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-isolated]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-isolated[quarkus.cloudwatchlogs.devservices.isolated]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-type]] [.property-path]##`quarkus.cloudwatch.aws.credentials.type`## +`quarkus.cloudwatch."client-name".aws.credentials.type` [.description] -- -Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +-- +a|AwsCredentialsProviderType +|`default` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-service-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-service-name[quarkus.cloudwatchlogs.devservices.service-name]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.cloudwatch."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.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. +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. -This property is used when you need multiple shared LocalStack instances. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|string -|`localstack` - +-- +|boolean +|`false` -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-container-properties-container-properties]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-devservices-container-properties-container-properties[quarkus.cloudwatchlogs.devservices.container-properties."container-properties"]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.default-provider.reuse-last-provider-enabled`## +`quarkus.cloudwatch."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- -Generic properties that are pass for additional container configuration. +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -| - +-- +|boolean +|`true` -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sdk-aws-sdk-client-configurations[AWS SDK client configurations] +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-endpoint-override]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-endpoint-override[quarkus.cloudwatch.endpoint-override]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.access-key-id`## +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.access-key-id` [.description] -- -The endpoint URI with which the SDK should communicate. +AWS Access key id -If not specified, an appropriate endpoint to be used for the given service and region. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|string | +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-timeout[quarkus.cloudwatch.api-call-timeout]` - +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- -The amount of time to allow the client to complete the execution of an API call. - -This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. +AWS Secret access key -This value should always be positive, if present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|string | +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-attempt-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-attempt-timeout[quarkus.cloudwatch.api-call-attempt-timeout]` - +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.session-token` [.description] -- -The amount of time to wait for the HTTP request to complete before giving up and timing out. +AWS Session token -This value should always be positive, if present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|string | -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-advanced-use-quarkus-scheduled-executor-service[quarkus.cloudwatch.advanced.use-quarkus-scheduled-executor-service]` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cloudwatch.aws.credentials.profile-provider.profile-name`## +`quarkus.cloudwatch."client-name".aws.credentials.profile-provider.profile-name` [.description] -- -Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. -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_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +-- +|string +| -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-endpoint-override]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-endpoint-override[quarkus.cloudwatchlogs.endpoint-override]` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- -The endpoint URI with which the SDK should communicate. +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. -If not specified, an appropriate endpoint to be used for the given service and region. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - +-- +|boolean +|`false` -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-api-call-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-api-call-timeout[quarkus.cloudwatchlogs.api-call-timeout]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.credential-refresh-threshold`## +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- -The amount of time to allow the client to complete the execution of an API call. +The amount of time between when the credentials expire and when the credentials should start to be refreshed. -This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. -This value should always be positive, if present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-api-call-attempt-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-api-call-attempt-timeout[quarkus.cloudwatchlogs.api-call-attempt-timeout]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.process-output-limit`## +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.process-output-limit` [.description] -- -The amount of time to wait for the HTTP request to complete before giving up and timing out. +The maximum size of the output that can be returned by the external process before an exception is raised. -This value should always be positive, if present. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service[quarkus.cloudwatchlogs.advanced.use-quarkus-scheduled-executor-service]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.command`## +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.command` [.description] -- -Whether the Quarkus thread pool should be used for scheduling tasks such as async retry attempts and timeout task. +The command that should be executed to retrieve credentials. -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_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` - +-- +|string +| -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-aws-services-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-aws-services-configurations[AWS services configurations] +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-region]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-region[quarkus.cloudwatch.aws.region]` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cloudwatch.aws.credentials.custom-provider.name`## +`quarkus.cloudwatch."client-name".aws.credentials.custom-provider.name` [.description] -- -An Amazon Web Services region that hosts the given service. +The name of custom AwsCredentialsProvider bean. -It overrides region provider chain with static value of -region with which the service client should communicate. - -If not set, region is retrieved via the default providers chain in the following order: - -* `aws.region` system property -* `region` property from the profile file -* Instance profile file - -See `software.amazon.awssdk.regions.Region` for available regions. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_REGION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_REGION+++` -endif::add-copy-button-to-env-var[] ---|Region -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-type[quarkus.cloudwatch.aws.credentials.type]` - - -[.description] --- -Configure the credentials provider that should be used to authenticate with AWS. - -Available values: - -* `default` - the provider will attempt to identify the credentials automatically using the following checks: -** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` -** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` -** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI -** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. -** Instance profile credentials delivered through the Amazon EC2 metadata service -* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. -* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. -* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. -* `profile` - credentials are based on AWS configuration profiles. This loads credentials from - a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], - allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. -* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are - **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** -* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. -* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile - credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] - for more information. -* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will - fail unless the resource or API's policy has been configured to specifically allow anonymous access. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` -|`default` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-region]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-region[quarkus.cloudwatchlogs.aws.region]` - - -[.description] --- -An Amazon Web Services region that hosts the given service. - -It overrides region provider chain with static value of -region with which the service client should communicate. - -If not set, region is retrieved via the default providers chain in the following order: - -* `aws.region` system property -* `region` property from the profile file -* Instance profile file - -See `software.amazon.awssdk.regions.Region` for available regions. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++` -endif::add-copy-button-to-env-var[] ---|Region -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-type[quarkus.cloudwatchlogs.aws.credentials.type]` - - -[.description] --- -Configure the credentials provider that should be used to authenticate with AWS. - -Available values: - -* `default` - the provider will attempt to identify the credentials automatically using the following checks: -** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` -** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` -** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI -** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. -** Instance profile credentials delivered through the Amazon EC2 metadata service -* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. -* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. -* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. -* `profile` - credentials are based on AWS configuration profiles. This loads credentials from - a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], - allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. -* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are - **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** -* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. -* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile - credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] - for more information. -* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will - fail unless the resource or API's policy has been configured to specifically allow anonymous access. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` -|`default` - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-async-credential-update-enabled[quarkus.cloudwatch.aws.credentials.default-provider.async-credential-update-enabled]` - - -[.description] --- -Whether this provider should fetch credentials asynchronously in the background. - -If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.cloudwatch.aws.credentials.default-provider.reuse-last-provider-enabled]` - - -[.description] --- -Whether the provider should reuse the last successful credentials provider in the chain. - -Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled[quarkus.cloudwatchlogs.aws.credentials.default-provider.async-credential-update-enabled]` - - -[.description] --- -Whether this provider should fetch credentials asynchronously in the background. - -If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.cloudwatchlogs.aws.credentials.default-provider.reuse-last-provider-enabled]` - - -[.description] --- -Whether the provider should reuse the last successful credentials provider in the chain. - -Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-access-key-id[quarkus.cloudwatch.aws.credentials.static-provider.access-key-id]` - - -[.description] --- -AWS Access key id - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-secret-access-key[quarkus.cloudwatch.aws.credentials.static-provider.secret-access-key]` - - -[.description] --- -AWS Secret access key - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-session-token[quarkus.cloudwatch.aws.credentials.static-provider.session-token]` - - -[.description] --- -AWS Session token - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id[quarkus.cloudwatchlogs.aws.credentials.static-provider.access-key-id]` - - -[.description] --- -AWS Access key id - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key[quarkus.cloudwatchlogs.aws.credentials.static-provider.secret-access-key]` - - -[.description] --- -AWS Secret access key - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token[quarkus.cloudwatchlogs.aws.credentials.static-provider.session-token]` - - -[.description] --- -AWS Session token - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-profile-name[quarkus.cloudwatch.aws.credentials.profile-provider.profile-name]` - - -[.description] --- -The name of the profile that should be used by this credentials provider. - -If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name[quarkus.cloudwatchlogs.aws.credentials.profile-provider.profile-name]` - - -[.description] --- -The name of the profile that should be used by this credentials provider. - -If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-async-credential-update-enabled[quarkus.cloudwatch.aws.credentials.process-provider.async-credential-update-enabled]` - - -[.description] --- -Whether the provider should fetch credentials asynchronously in the background. - -If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-credential-refresh-threshold[quarkus.cloudwatch.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. - -This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-output-limit[quarkus.cloudwatch.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` -endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] -|`1024` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-command]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-command[quarkus.cloudwatch.aws.credentials.process-provider.command]` - - -[.description] --- -The command that should be executed to retrieve credentials. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled[quarkus.cloudwatchlogs.aws.credentials.process-provider.async-credential-update-enabled]` - - -[.description] --- -Whether the provider should fetch credentials asynchronously in the background. - -If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold[quarkus.cloudwatchlogs.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. - -This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`15S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit[quarkus.cloudwatchlogs.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` -endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] -|`1024` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-command]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-process-provider-command[quarkus.cloudwatchlogs.aws.credentials.process-provider.command]` - - -[.description] --- -The command that should be executed to retrieve credentials. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-name[quarkus.cloudwatch.aws.credentials.custom-provider.name]` - - -[.description] --- -The name of custom AwsCredentialsProvider bean. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name[quarkus.cloudwatchlogs.aws.credentials.custom-provider.name]` - - -[.description] --- -The name of custom AwsCredentialsProvider bean. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-connection-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-connection-timeout[quarkus.cloudwatch.sync-client.connection-timeout]` - - -[.description] --- -The maximum amount of time to establish a connection before timing out. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`2S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-socket-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-socket-timeout[quarkus.cloudwatch.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-type[quarkus.cloudwatch.sync-client.tls-key-managers-provider.type]` - - -[.description] --- -TLS key managers provider type. - -Available providers: - -* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.path]` - - -[.description] --- -Path to the key store. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` -endif::add-copy-button-to-env-var[] ---|path -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.type]` - - -[.description] --- -Key store type. - -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.password]` - - -[.description] --- -Key store password - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-type[quarkus.cloudwatch.sync-client.tls-trust-managers-provider.type]` - - -[.description] --- -TLS trust managers provider type. - -Available providers: - -* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.path]` - - -[.description] --- -Path to the key store. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` -endif::add-copy-button-to-env-var[] ---|path -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.type]` - - -[.description] --- -Key store type. - -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.password]` - - -[.description] --- -Key store password - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-connection-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-connection-timeout[quarkus.cloudwatchlogs.sync-client.connection-timeout]` - - -[.description] --- -The maximum amount of time to establish a connection before timing out. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`2S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-socket-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-socket-timeout[quarkus.cloudwatchlogs.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.type]` - - -[.description] --- -TLS key managers provider type. - -Available providers: - -* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.path]` - - -[.description] --- -Path to the key store. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` -endif::add-copy-button-to-env-var[] ---|path -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.type]` - - -[.description] --- -Key store type. - -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.password]` - - -[.description] --- -Key store password - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.type]` - - -[.description] --- -TLS trust managers provider type. - -Available providers: - -* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` -endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.path]` - - -[.description] --- -Path to the key store. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` -endif::add-copy-button-to-env-var[] ---|path -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.type]` - - -[.description] --- -Key store type. - -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.password]` - - -[.description] --- -Key store password - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-acquisition-timeout[quarkus.cloudwatch.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-max-idle-time[quarkus.cloudwatch.sync-client.apache.connection-max-idle-time]` - - -[.description] --- -The maximum amount of time that a connection should be allowed to remain open while idle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-time-to-live[quarkus.cloudwatch.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-max-connections]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-max-connections[quarkus.cloudwatch.sync-client.apache.max-connections]` - - -[.description] --- -The maximum number of connections allowed in the connection pool. - -Each built HTTP client has its own private connection pool. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` -endif::add-copy-button-to-env-var[] ---|int -|`50` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-expect-continue-enabled[quarkus.cloudwatch.sync-client.apache.expect-continue-enabled]` - - -[.description] --- -Whether the client should send an HTTP expect-continue handshake before each request. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-use-idle-connection-reaper[quarkus.cloudwatch.sync-client.apache.use-idle-connection-reaper]` - - -[.description] --- -Whether the idle connections in the connection pool should be closed asynchronously. - -When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-tcp-keep-alive[quarkus.cloudwatch.sync-client.apache.tcp-keep-alive]` - - -[.description] --- -Configure whether to enable or disable TCP KeepAlive. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-enabled[quarkus.cloudwatch.sync-client.apache.proxy.enabled]` - - -[.description] --- -Enable HTTP proxy - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-endpoint[quarkus.cloudwatch.sync-client.apache.proxy.endpoint]` - - -[.description] --- -The endpoint of the proxy server that the SDK should connect through. - -Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-username]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-username[quarkus.cloudwatch.sync-client.apache.proxy.username]` - - -[.description] --- -The username to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-password[quarkus.cloudwatch.sync-client.apache.proxy.password]` - - -[.description] --- -The password to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-domain[quarkus.cloudwatch.sync-client.apache.proxy.ntlm-domain]` - - -[.description] --- -For NTLM proxies - the Windows domain name to use when authenticating with the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-workstation[quarkus.cloudwatch.sync-client.apache.proxy.ntlm-workstation]` - - -[.description] --- -For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.cloudwatch.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - - -[.description] --- -Whether to attempt to authenticate preemptively against the proxy server using basic authentication. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-non-proxy-hosts[quarkus.cloudwatch.sync-client.apache.proxy.non-proxy-hosts]` - - -[.description] --- -The hosts that the client is allowed to access without going through the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` -endif::add-copy-button-to-env-var[] ---|list of string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout[quarkus.cloudwatchlogs.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time[quarkus.cloudwatchlogs.sync-client.apache.connection-max-idle-time]` - - -[.description] --- -The maximum amount of time that a connection should be allowed to remain open while idle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live[quarkus.cloudwatchlogs.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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-max-connections]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-max-connections[quarkus.cloudwatchlogs.sync-client.apache.max-connections]` - - -[.description] --- -The maximum number of connections allowed in the connection pool. - -Each built HTTP client has its own private connection pool. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` -endif::add-copy-button-to-env-var[] ---|int -|`50` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled[quarkus.cloudwatchlogs.sync-client.apache.expect-continue-enabled]` - - -[.description] --- -Whether the client should send an HTTP expect-continue handshake before each request. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper[quarkus.cloudwatchlogs.sync-client.apache.use-idle-connection-reaper]` - - -[.description] --- -Whether the idle connections in the connection pool should be closed asynchronously. - -When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`true` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive[quarkus.cloudwatchlogs.sync-client.apache.tcp-keep-alive]` - - -[.description] --- -Configure whether to enable or disable TCP KeepAlive. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled[quarkus.cloudwatchlogs.sync-client.apache.proxy.enabled]` - - -[.description] --- -Enable HTTP proxy - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint[quarkus.cloudwatchlogs.sync-client.apache.proxy.endpoint]` - - -[.description] --- -The endpoint of the proxy server that the SDK should connect through. - -Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-username]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-username[quarkus.cloudwatchlogs.sync-client.apache.proxy.username]` - - -[.description] --- -The username to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-password[quarkus.cloudwatchlogs.sync-client.apache.proxy.password]` - - -[.description] --- -The password to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain[quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-domain]` - - -[.description] --- -For NTLM proxies - the Windows domain name to use when authenticating with the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation[quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-workstation]` - - -[.description] --- -For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.cloudwatchlogs.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - - -[.description] --- -Whether to attempt to authenticate preemptively against the proxy server using basic authentication. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|boolean -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts[quarkus.cloudwatchlogs.sync-client.apache.proxy.non-proxy-hosts]` - - -[.description] -- -The hosts that the client is allowed to access without going through the proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` -endif::add-copy-button-to-env-var[] ---|list of string +|string | -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-connection-max-idle-time[quarkus.cloudwatch.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-connection-timeout]] [.property-path]##`quarkus.cloudwatch.sync-client.connection-timeout`## [.description] -- -The maximum amount of time that a connection should be allowed to remain open while idle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-max-concurrency[quarkus.cloudwatch.sync-client.crt.max-concurrency]` - +The maximum amount of time to establish a connection before timing out. -[.description] --- -The maximum number of allowed concurrent requests. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|int -|`50` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-enabled[quarkus.cloudwatch.sync-client.crt.proxy.enabled]` - - -[.description] -- -Enable HTTP proxy - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-endpoint[quarkus.cloudwatch.sync-client.crt.proxy.endpoint]` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-socket-timeout]] [.property-path]##`quarkus.cloudwatch.sync-client.socket-timeout`## [.description] -- -The endpoint of the proxy server that the SDK should connect through. - -Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-username]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-username[quarkus.cloudwatch.sync-client.crt.proxy.username]` - +The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. -[.description] --- -The username to use when connecting through a proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-password[quarkus.cloudwatch.sync-client.crt.proxy.password]` - - -[.description] -- -The password to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time[quarkus.cloudwatchlogs.sync-client.crt.connection-max-idle-time]` +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.type`## [.description] -- -The maximum amount of time that a connection should be allowed to remain open while idle. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`60S` - +TLS key managers provider type. -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency[quarkus.cloudwatchlogs.sync-client.crt.max-concurrency]` +Available providers: +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. -[.description] --- -The maximum number of allowed concurrent requests. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] ---|int -|`50` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled[quarkus.cloudwatchlogs.sync-client.crt.proxy.enabled]` - - -[.description] -- -Enable HTTP proxy - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` -endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint[quarkus.cloudwatchlogs.sync-client.crt.proxy.endpoint]` +a|TlsKeyManagersProviderType +|`system-property` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- -The endpoint of the proxy server that the SDK should connect through. - -Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-username]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-username[quarkus.cloudwatchlogs.sync-client.crt.proxy.username]` - +Path to the key store. -[.description] --- -The username to use when connecting through a proxy. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-sync-client-crt-proxy-password[quarkus.cloudwatchlogs.sync-client.crt.proxy.password]` - - -[.description] -- -The password to use when connecting through a proxy. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` -endif::add-copy-button-to-env-var[] ---|string +|path | - -h|[[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-async-http-transport-configurations]]link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-async-http-transport-configurations[Async HTTP transport configurations] - -h|Type -h|Default - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-concurrency]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-concurrency[quarkus.cloudwatch.async-client.max-concurrency]` - - -[.description] --- -The maximum number of allowed concurrent requests. - -For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++` -endif::add-copy-button-to-env-var[] ---|int -|`50` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-pending-connection-acquires[quarkus.cloudwatch.async-client.max-pending-connection-acquires]` - - -[.description] --- -The maximum number of pending acquires allowed. - -Once this exceeds, acquire tries will be failed. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` -endif::add-copy-button-to-env-var[] ---|int -|`10000` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-read-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-read-timeout[quarkus.cloudwatch.async-client.read-timeout]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- -The amount of time to wait for a read on a socket before an exception is thrown. - -Specify `0` to disable. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-write-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-write-timeout[quarkus.cloudwatch.async-client.write-timeout]` - +Key store type. -[.description] --- -The amount of time to wait for a write on a socket before an exception is thrown. +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. -Specify `0` to disable. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`30S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-timeout[quarkus.cloudwatch.async-client.connection-timeout]` +-- +|string +| +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- -The amount of time to wait when initially establishing a connection before giving up and timing out. +Key store password + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`10S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-acquisition-timeout[quarkus.cloudwatch.async-client.connection-acquisition-timeout]` +-- +|string +| +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.type`## [.description] -- -The amount of time to wait when acquiring a connection from the pool before giving up and timing out. +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`2S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-time-to-live]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-time-to-live[quarkus.cloudwatch.async-client.connection-time-to-live]` +-- +a|TlsTrustManagersProviderType +|`system-property` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- -The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. +Path to the key store. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|path | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-max-idle-time[quarkus.cloudwatch.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- -The maximum amount of time that a connection should be allowed to remain open while idle. +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. -Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`5S` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-use-idle-connection-reaper[quarkus.cloudwatch.async-client.use-idle-connection-reaper]` +-- +|string +| +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- -Whether the idle connections in the connection pool should be closed. +Key store password -When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` - +-- +|string +| -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tcp-keep-alive[quarkus.cloudwatch.async-client.tcp-keep-alive]` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.connection-acquisition-timeout`## [.description] -- -Configure whether to enable or disable TCP KeepAlive. +The amount of time to wait when acquiring a connection from the pool before giving up and timing out. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-protocol]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-protocol[quarkus.cloudwatch.async-client.protocol]` +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.connection-max-idle-time`## [.description] -- -The HTTP protocol to use. +The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` -|`http1-1` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-ssl-provider]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-ssl-provider[quarkus.cloudwatch.async-client.ssl-provider]` +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.connection-time-to-live`## [.description] -- -The SSL Provider to be used in the Netty client. +The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. -Default is `OPENSSL` if available, `JDK` otherwise. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-max-streams]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-max-streams[quarkus.cloudwatch.async-client.http2.max-streams]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-max-connections]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.max-connections`## [.description] -- -The maximum number of concurrent streams for an HTTP/2 connection. +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. -This setting is only respected when the HTTP/2 protocol is used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|long -|`4294967295` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-initial-window-size]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-initial-window-size[quarkus.cloudwatch.async-client.http2.initial-window-size]` +-- +|int +|`50` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.expect-continue-enabled`## [.description] -- -The initial window size for an HTTP/2 stream. +Whether the client should send an HTTP expect-continue handshake before each request. -This setting is only respected when the HTTP/2 protocol is used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|int -|`1048576` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-health-check-ping-period[quarkus.cloudwatch.async-client.http2.health-check-ping-period]` +-- +|boolean +|`true` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.use-idle-connection-reaper`## [.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. +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. -This setting is only respected when the HTTP/2 protocol is used. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] -|`5` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-enabled[quarkus.cloudwatch.async-client.proxy.enabled]` +-- +|boolean +|`true` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.tcp-keep-alive`## [.description] -- -Enable HTTP proxy. +Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-endpoint[quarkus.cloudwatch.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.enabled`## [.description] -- -The endpoint of the proxy server that the SDK should connect through. +Enable HTTP proxy -Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-non-proxy-hosts[quarkus.cloudwatch.async-client.proxy.non-proxy-hosts]` +-- +|boolean +|`false` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.endpoint`## [.description] -- -The hosts that the client is allowed to access without going through the proxy. +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-type[quarkus.cloudwatch.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.username`## [.description] -- -TLS key managers provider type. - -Available providers: +The username to use when connecting through a proxy. -* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.path]` +-- +|string +| +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.password`## [.description] -- -Path to the key store. +The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|path +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.ntlm-domain`## [.description] -- -Key store type. +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.ntlm-workstation`## [.description] -- -Key store password +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-type[quarkus.cloudwatch.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- -TLS trust managers provider type. - -Available providers: +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. -* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. -* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and - `javax.net.ssl.keyStoreType` properties defined by the - https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. -* `file-store` - Provider that loads the key store from a file. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` -|`system-property` - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.path]` +-- +|boolean +| +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- -Path to the key store. +The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|path +-- +|list of string | -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.type]` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.connection-max-idle-time`## [.description] -- -Key store type. +The maximum amount of time that a connection should be allowed to remain open while idle. -See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.password]` +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.max-concurrency`## [.description] -- -Key store password +The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|string -| - - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-override]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-override[quarkus.cloudwatch.async-client.event-loop.override]` +-- +|int +|`50` +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.enabled`## [.description] -- -Enable the custom configuration of the Netty event loop group. +Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-number-of-threads[quarkus.cloudwatch.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.endpoint`## [.description] -- -Number of threads to use for the event loop group. +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. -If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-thread-name-prefix[quarkus.cloudwatch.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.username`## [.description] -- -The thread name prefix for threads created by this thread factory used by event loop group. - -The prefix will be appended with a number unique to the thread factory and a number unique to the thread. +The username to use when connecting through a proxy. -If not specified it defaults to `aws-java-sdk-NettyEventLoop` ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-advanced-use-future-completion-thread-pool[quarkus.cloudwatch.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.password`## [.description] -- -Whether the default thread pool should be used to complete the futures returned from the HTTP client request. +The password to use when connecting through a proxy. -When disabled, futures will be completed on the Netty event loop thread. ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|boolean -|`true` +-- +|string +| -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-max-concurrency]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-max-concurrency[quarkus.cloudwatchlogs.async-client.max-concurrency]` +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-concurrency]] [.property-path]##`quarkus.cloudwatch.async-client.max-concurrency`## [.description] -- @@ -2800,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires[quarkus.cloudwatchlogs.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cloudwatch.async-client.max-pending-connection-acquires`## [.description] -- @@ -2819,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-read-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-read-timeout[quarkus.cloudwatchlogs.async-client.read-timeout]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-read-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.read-timeout`## [.description] -- @@ -2838,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-write-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-write-timeout[quarkus.cloudwatchlogs.async-client.write-timeout]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-write-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.write-timeout`## [.description] -- @@ -2858,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-timeout[quarkus.cloudwatchlogs.async-client.connection-timeout]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout[quarkus.cloudwatchlogs.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatch.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. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-time-to-live]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-time-to-live[quarkus.cloudwatchlogs.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-time-to-live]] [.property-path]##`quarkus.cloudwatch.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. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-connection-max-idle-time[quarkus.cloudwatchlogs.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.async-client.connection-max-idle-time`## [.description] -- @@ -2932,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper[quarkus.cloudwatchlogs.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatch.async-client.use-idle-connection-reaper`## [.description] -- @@ -2952,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tcp-keep-alive[quarkus.cloudwatchlogs.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatch.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-protocol]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-protocol[quarkus.cloudwatchlogs.async-client.protocol]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-protocol]] [.property-path]##`quarkus.cloudwatch.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-ssl-provider]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-ssl-provider[quarkus.cloudwatchlogs.async-client.ssl-provider]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-ssl-provider]] [.property-path]##`quarkus.cloudwatch.async-client.ssl-provider`## [.description] -- @@ -3006,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-max-streams]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-max-streams[quarkus.cloudwatchlogs.async-client.http2.max-streams]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-max-streams]] [.property-path]##`quarkus.cloudwatch.async-client.http2.max-streams`## [.description] -- @@ -3026,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-initial-window-size]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-initial-window-size[quarkus.cloudwatchlogs.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cloudwatch.async-client.http2.initial-window-size`## [.description] -- @@ -3045,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period[quarkus.cloudwatchlogs.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.cloudwatch.async-client.http2.health-check-ping-period`## [.description] -- @@ -3064,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-enabled]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-enabled[quarkus.cloudwatchlogs.async-client.proxy.enabled]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-endpoint]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-endpoint[quarkus.cloudwatchlogs.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.endpoint`## [.description] -- @@ -3101,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts[quarkus.cloudwatchlogs.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.type`## [.description] -- @@ -3144,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -3181,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -3223,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -3260,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-override]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-override[quarkus.cloudwatchlogs.async-client.event-loop.override]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-override]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads[quarkus.cloudwatchlogs.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.number-of-threads`## [.description] -- @@ -3313,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix[quarkus.cloudwatchlogs.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -3334,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-cloudwatch_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool[quarkus.cloudwatchlogs.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.cloudwatch.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -3353,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-cloudwatch_quarkus-cloudwatch] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -3382,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-cloudwatch_quarkus-cloudwatch] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch_quarkus.cloudwatch.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch_quarkus.cloudwatch.adoc new file mode 100644 index 000000000..8d9381958 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatch_quarkus.cloudwatch.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-cloudwatch_quarkus-cloudwatch +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-interceptors]] [.property-path]##`quarkus.cloudwatch.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-telemetry-enabled]] [.property-path]##`quarkus.cloudwatch.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-type]] [.property-path]##`quarkus.cloudwatch.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-type]] [.property-path]##`quarkus.cloudwatch.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-enabled]] [.property-path]##`quarkus.cloudwatch.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-shared]] [.property-path]##`quarkus.cloudwatch.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-isolated]] [.property-path]##`quarkus.cloudwatch.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-service-name]] [.property-path]##`quarkus.cloudwatch.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cloudwatch.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-endpoint-override]] [.property-path]##`quarkus.cloudwatch.endpoint-override`## + +`quarkus.cloudwatch."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-timeout]] [.property-path]##`quarkus.cloudwatch.api-call-timeout`## + +`quarkus.cloudwatch."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-api-call-attempt-timeout]] [.property-path]##`quarkus.cloudwatch.api-call-attempt-timeout`## + +`quarkus.cloudwatch."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cloudwatch.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.cloudwatch."client-name".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_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-region]] [.property-path]##`quarkus.cloudwatch.aws.region`## + +`quarkus.cloudwatch."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-type]] [.property-path]##`quarkus.cloudwatch.aws.credentials.type`## + +`quarkus.cloudwatch."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.cloudwatch."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.cloudwatch."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.access-key-id`## + +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.secret-access-key`## + +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cloudwatch.aws.credentials.static-provider.session-token`## + +`quarkus.cloudwatch."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cloudwatch.aws.credentials.profile-provider.profile-name`## + +`quarkus.cloudwatch."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.cloudwatch."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.process-output-limit`## + +`quarkus.cloudwatch."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cloudwatch.aws.credentials.process-provider.command`## + +`quarkus.cloudwatch."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cloudwatch.aws.credentials.custom-provider.name`## + +`quarkus.cloudwatch."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-connection-timeout]] [.property-path]##`quarkus.cloudwatch.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-socket-timeout]] [.property-path]##`quarkus.cloudwatch.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatch.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.cloudwatch.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-max-connections]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatch.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cloudwatch.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cloudwatch_section_quarkus-cloudwatch-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-concurrency]] [.property-path]##`quarkus.cloudwatch.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cloudwatch.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-read-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-write-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-timeout]] [.property-path]##`quarkus.cloudwatch.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatch.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-time-to-live]] [.property-path]##`quarkus.cloudwatch.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatch.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatch.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatch.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-protocol]] [.property-path]##`quarkus.cloudwatch.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-ssl-provider]] [.property-path]##`quarkus.cloudwatch.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-max-streams]] [.property-path]##`quarkus.cloudwatch.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cloudwatch.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.cloudwatch.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-enabled]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-endpoint]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatch.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatch.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-override]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.cloudwatch.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatch_quarkus-cloudwatch-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.cloudwatch.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCH_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-cloudwatch_quarkus-cloudwatch] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-cloudwatch_quarkus-cloudwatch] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs.adoc index 9b7366223..9aa428ba5 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-cloudwatchlogs +:summaryTableId: quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-cloudwatchlogs_configuration]]link:#quarkus-amazon-cloudwatchlogs_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-interceptors]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-interceptors[quarkus.cloudwatchlogs.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-interceptors]] [.property-path]##`quarkus.cloudwatchlogs.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-telemetry-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-telemetry-enabled[quarkus.cloudwatchlogs.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-telemetry-enabled]] [.property-path]##`quarkus.cloudwatchlogs.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-type[quarkus.cloudwatchlogs.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-type[quarkus.cloudwatchlogs.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-enabled[quarkus.cloudwatchlogs.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-enabled]] [.property-path]##`quarkus.cloudwatchlogs.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-shared]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-shared[quarkus.cloudwatchlogs.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-shared]] [.property-path]##`quarkus.cloudwatchlogs.devservices.shared`## [.description] -- @@ -110,59 +105,77 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-isolated]] [.property-path]##`quarkus.cloudwatchlogs.devservices.isolated`## -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-service-name]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-service-name[quarkus.cloudwatchlogs.devservices.service-name]` +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-service-name]] [.property-path]##`quarkus.cloudwatchlogs.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. This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-container-properties-container-properties]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-container-properties-container-properties[quarkus.cloudwatchlogs.devservices.container-properties]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cloudwatchlogs.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES+++` +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|`Map` +-- +|Map | - -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-endpoint-override]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-endpoint-override[quarkus.cloudwatchlogs.endpoint-override]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-endpoint-override]] [.property-path]##`quarkus.cloudwatchlogs.endpoint-override`## +`quarkus.cloudwatchlogs."client-name".endpoint-override` [.description] -- @@ -170,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-timeout]] [.property-path]##`quarkus.cloudwatchlogs.api-call-timeout`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-timeout[quarkus.cloudwatchlogs.api-call-timeout]` - +`quarkus.cloudwatchlogs."client-name".api-call-timeout` [.description] -- @@ -192,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-attempt-timeout]] [.property-path]##`quarkus.cloudwatchlogs.api-call-attempt-timeout`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-attempt-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-attempt-timeout[quarkus.cloudwatchlogs.api-call-attempt-timeout]` - +`quarkus.cloudwatchlogs."client-name".api-call-attempt-timeout` [.description] -- @@ -212,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cloudwatchlogs.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service[quarkus.cloudwatchlogs.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.cloudwatchlogs."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -232,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-aws-services-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-region]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-region[quarkus.cloudwatchlogs.aws.region]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-region]] [.property-path]##`quarkus.cloudwatchlogs.aws.region`## +`quarkus.cloudwatchlogs."client-name".aws.region` [.description] -- @@ -265,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-type]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.type`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-type[quarkus.cloudwatchlogs.aws.credentials.type]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.type` [.description] -- @@ -305,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled[quarkus.cloudwatchlogs.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.cloudwatchlogs."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -330,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.cloudwatchlogs.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -349,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id[quarkus.cloudwatchlogs.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.access-key-id`## +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key[quarkus.cloudwatchlogs.aws.credentials.static-provider.secret-access-key]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token[quarkus.cloudwatchlogs.aws.credentials.static-provider.session-token]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name[quarkus.cloudwatchlogs.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.profile-provider.profile-name`## +`quarkus.cloudwatchlogs."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -429,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled[quarkus.cloudwatchlogs.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.cloudwatchlogs."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -453,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold[quarkus.cloudwatchlogs.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -472,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit[quarkus.cloudwatchlogs.aws.credentials.process-provider.process-output-limit]` - +`quarkus.cloudwatchlogs."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[], title=More information about the MemorySize format] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-command]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-command[quarkus.cloudwatchlogs.aws.credentials.process-provider.command]` - +`quarkus.cloudwatchlogs."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name[quarkus.cloudwatchlogs.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.custom-provider.name`## +`quarkus.cloudwatchlogs."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-connection-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-connection-timeout[quarkus.cloudwatchlogs.sync-client.connection-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-connection-timeout]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-socket-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-socket-timeout[quarkus.cloudwatchlogs.sync-client.socket-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-socket-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -595,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -632,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -674,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -711,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout[quarkus.cloudwatchlogs.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time[quarkus.cloudwatchlogs.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live[quarkus.cloudwatchlogs.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.cloudwatchlogs.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-max-connections]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-max-connections[quarkus.cloudwatchlogs.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-max-connections]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.max-connections`## [.description] -- @@ -806,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled[quarkus.cloudwatchlogs.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper[quarkus.cloudwatchlogs.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -842,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive[quarkus.cloudwatchlogs.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled[quarkus.cloudwatchlogs.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint[quarkus.cloudwatchlogs.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.endpoint`## [.description] -- @@ -895,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-username]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-username[quarkus.cloudwatchlogs.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-password[quarkus.cloudwatchlogs.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain[quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation[quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.cloudwatchlogs.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts[quarkus.cloudwatchlogs.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time[quarkus.cloudwatchlogs.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency[quarkus.cloudwatchlogs.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled[quarkus.cloudwatchlogs.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint[quarkus.cloudwatchlogs.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1074,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-username]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-username[quarkus.cloudwatchlogs.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-password[quarkus.cloudwatchlogs.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-async-http-transport-configurations]]link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-concurrency]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-concurrency[quarkus.cloudwatchlogs.async-client.max-concurrency]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-concurrency]] [.property-path]##`quarkus.cloudwatchlogs.async-client.max-concurrency`## [.description] -- @@ -1133,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires[quarkus.cloudwatchlogs.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cloudwatchlogs.async-client.max-pending-connection-acquires`## [.description] -- @@ -1152,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-read-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-read-timeout[quarkus.cloudwatchlogs.async-client.read-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-read-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.read-timeout`## [.description] -- @@ -1171,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-write-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-write-timeout[quarkus.cloudwatchlogs.async-client.write-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-write-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.write-timeout`## [.description] -- @@ -1191,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-timeout[quarkus.cloudwatchlogs.async-client.connection-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout[quarkus.cloudwatchlogs.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-time-to-live]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-time-to-live[quarkus.cloudwatchlogs.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-time-to-live]] [.property-path]##`quarkus.cloudwatchlogs.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-max-idle-time]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-max-idle-time[quarkus.cloudwatchlogs.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.async-client.connection-max-idle-time`## [.description] -- @@ -1265,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper[quarkus.cloudwatchlogs.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatchlogs.async-client.use-idle-connection-reaper`## [.description] -- @@ -1285,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tcp-keep-alive]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tcp-keep-alive[quarkus.cloudwatchlogs.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-protocol]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-protocol[quarkus.cloudwatchlogs.async-client.protocol]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-protocol]] [.property-path]##`quarkus.cloudwatchlogs.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-ssl-provider]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-ssl-provider[quarkus.cloudwatchlogs.async-client.ssl-provider]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-ssl-provider]] [.property-path]##`quarkus.cloudwatchlogs.async-client.ssl-provider`## [.description] -- @@ -1339,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-max-streams]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-max-streams[quarkus.cloudwatchlogs.async-client.http2.max-streams]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-max-streams]] [.property-path]##`quarkus.cloudwatchlogs.async-client.http2.max-streams`## [.description] -- @@ -1359,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-initial-window-size]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-initial-window-size[quarkus.cloudwatchlogs.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cloudwatchlogs.async-client.http2.initial-window-size`## [.description] -- @@ -1378,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period[quarkus.cloudwatchlogs.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.cloudwatchlogs.async-client.http2.health-check-ping-period`## [.description] -- @@ -1397,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-enabled]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-enabled[quarkus.cloudwatchlogs.async-client.proxy.enabled]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-endpoint]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-endpoint[quarkus.cloudwatchlogs.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.endpoint`## [.description] -- @@ -1434,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts[quarkus.cloudwatchlogs.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1477,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1514,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password[quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1556,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1593,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password[quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-override]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-override[quarkus.cloudwatchlogs.async-client.event-loop.override]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-override]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads[quarkus.cloudwatchlogs.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.number-of-threads`## [.description] -- @@ -1646,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix[quarkus.cloudwatchlogs.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1667,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool[quarkus.cloudwatchlogs.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.cloudwatchlogs.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1686,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1715,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs_quarkus.cloudwatchlogs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs_quarkus.cloudwatchlogs.adoc new file mode 100644 index 000000000..9aa428ba5 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cloudwatchlogs_quarkus.cloudwatchlogs.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-interceptors]] [.property-path]##`quarkus.cloudwatchlogs.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-telemetry-enabled]] [.property-path]##`quarkus.cloudwatchlogs.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-enabled]] [.property-path]##`quarkus.cloudwatchlogs.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-shared]] [.property-path]##`quarkus.cloudwatchlogs.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-isolated]] [.property-path]##`quarkus.cloudwatchlogs.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-service-name]] [.property-path]##`quarkus.cloudwatchlogs.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cloudwatchlogs.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-endpoint-override]] [.property-path]##`quarkus.cloudwatchlogs.endpoint-override`## + +`quarkus.cloudwatchlogs."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-timeout]] [.property-path]##`quarkus.cloudwatchlogs.api-call-timeout`## + +`quarkus.cloudwatchlogs."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-api-call-attempt-timeout]] [.property-path]##`quarkus.cloudwatchlogs.api-call-attempt-timeout`## + +`quarkus.cloudwatchlogs."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cloudwatchlogs.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.cloudwatchlogs."client-name".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_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-region]] [.property-path]##`quarkus.cloudwatchlogs.aws.region`## + +`quarkus.cloudwatchlogs."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-type]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.type`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.access-key-id`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.secret-access-key`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.static-provider.session-token`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.profile-provider.profile-name`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.cloudwatchlogs."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.process-output-limit`## + +`quarkus.cloudwatchlogs."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.process-provider.command`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cloudwatchlogs.aws.credentials.custom-provider.name`## + +`quarkus.cloudwatchlogs."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-connection-timeout]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-socket-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.cloudwatchlogs.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-max-connections]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cloudwatchlogs.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cloudwatchlogs_section_quarkus-cloudwatchlogs-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-concurrency]] [.property-path]##`quarkus.cloudwatchlogs.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cloudwatchlogs.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-read-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-write-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-timeout]] [.property-path]##`quarkus.cloudwatchlogs.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.cloudwatchlogs.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-time-to-live]] [.property-path]##`quarkus.cloudwatchlogs.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-connection-max-idle-time]] [.property-path]##`quarkus.cloudwatchlogs.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cloudwatchlogs.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-protocol]] [.property-path]##`quarkus.cloudwatchlogs.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-ssl-provider]] [.property-path]##`quarkus.cloudwatchlogs.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-max-streams]] [.property-path]##`quarkus.cloudwatchlogs.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cloudwatchlogs.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.cloudwatchlogs.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-enabled]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-endpoint]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.cloudwatchlogs.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cloudwatchlogs.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-override]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.cloudwatchlogs.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.cloudwatchlogs.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_CLOUDWATCHLOGS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-cloudwatchlogs_quarkus-cloudwatchlogs] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools.adoc similarity index 61% rename from docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc rename to docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools.adoc index a4006b947..fe56fb900 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognitouserpools.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-cognitouserpools +:summaryTableId: quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-cognitouserpools_configuration]]link:#quarkus-amazon-cognitouserpools_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-interceptors]] [.property-path]##`quarkus.cognito-user-pools.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-telemetry-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-telemetry-enabled[quarkus.cognito-user-pools.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-telemetry-enabled]] [.property-path]##`quarkus.cognito-user-pools.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-shared]] [.property-path]##`quarkus.cognito-user-pools.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-devservices-isolated]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-devservices-isolated[quarkus.cognito-user-pools.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-isolated]] [.property-path]##`quarkus.cognito-user-pools.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-service-name]] [.property-path]##`quarkus.cognito-user-pools.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cognito-user-pools.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools]] [.section-name.section-level0]##AWS SDK client configurations## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-endpoint-override]] [.property-path]##`quarkus.cognito-user-pools.endpoint-override`## +`quarkus.cognito-user-pools."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-api-call-timeout]] [.property-path]##`quarkus.cognito-user-pools.api-call-timeout`## -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]` - +`quarkus.cognito-user-pools."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-api-call-attempt-timeout]] [.property-path]##`quarkus.cognito-user-pools.api-call-attempt-timeout`## -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]` - +`quarkus.cognito-user-pools."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cognito-user-pools.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.cognito-user-pools."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws]] [.section-name.section-level0]##AWS services configurations## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-region]] [.property-path]##`quarkus.cognito-user-pools.aws.region`## +`quarkus.cognito-user-pools."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-type]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.type`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.cognito-user-pools."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.access-key-id`## +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.profile-provider.profile-name`## +`quarkus.cognito-user-pools."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.cognito-user-pools."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.cognito-user-pools."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.command`## -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]` - +`quarkus.cognito-user-pools."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.custom-provider.name`## +`quarkus.cognito-user-pools."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-connection-timeout]] [.property-path]##`quarkus.cognito-user-pools.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-max-connections]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-connection-max-idle-time[quarkus.cognito-user-pools.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-max-concurrency[quarkus.cognito-user-pools.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-enabled[quarkus.cognito-user-pools.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-endpoint[quarkus.cognito-user-pools.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-username]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-username[quarkus.cognito-user-pools.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-password]]`link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-sync-client-crt-proxy-password[quarkus.cognito-user-pools.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-async-client-async-http-transport-configurations]]link:#quarkus-amazon-cognitouserpools_quarkus-cognito-user-pools-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-max-concurrency]] [.property-path]##`quarkus.cognito-user-pools.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cognito-user-pools.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-read-timeout]] [.property-path]##`quarkus.cognito-user-pools.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-write-timeout]] [.property-path]##`quarkus.cognito-user-pools.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-max-idle-time]] [.property-path]##`quarkus.cognito-user-pools.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cognito-user-pools.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cognito-user-pools.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-protocol]] [.property-path]##`quarkus.cognito-user-pools.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-ssl-provider]] [.property-path]##`quarkus.cognito-user-pools.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-max-streams]] [.property-path]##`quarkus.cognito-user-pools.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cognito-user-pools.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.cognito-user-pools.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-non-proxy-hosts]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-override]] [.property-path]##`quarkus.cognito-user-pools.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cognito-user-pools.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.cognito-user-pools.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.cognito-user-pools.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools_quarkus.cognito-user-pools.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools_quarkus.cognito-user-pools.adoc new file mode 100644 index 000000000..fe56fb900 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-cognito-user-pools_quarkus.cognito-user-pools.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-telemetry-enabled]] [.property-path]##`quarkus.cognito-user-pools.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-isolated]] [.property-path]##`quarkus.cognito-user-pools.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-devservices-container-properties-container-properties]] [.property-path]##`quarkus.cognito-user-pools.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-endpoint-override]] [.property-path]##`quarkus.cognito-user-pools.endpoint-override`## + +`quarkus.cognito-user-pools."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-api-call-timeout]] [.property-path]##`quarkus.cognito-user-pools.api-call-timeout`## + +`quarkus.cognito-user-pools."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-api-call-attempt-timeout]] [.property-path]##`quarkus.cognito-user-pools.api-call-attempt-timeout`## + +`quarkus.cognito-user-pools."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.cognito-user-pools.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.cognito-user-pools."client-name".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-cognito-user-pools_section_quarkus-cognito-user-pools-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-region]] [.property-path]##`quarkus.cognito-user-pools.aws.region`## + +`quarkus.cognito-user-pools."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-type]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.type`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.access-key-id`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.secret-access-key`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.static-provider.session-token`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.profile-provider.profile-name`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.cognito-user-pools."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.process-output-limit`## + +`quarkus.cognito-user-pools."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-process-provider-command]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.process-provider.command`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.cognito-user-pools.aws.credentials.custom-provider.name`## + +`quarkus.cognito-user-pools."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-connection-timeout]] [.property-path]##`quarkus.cognito-user-pools.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-max-connections]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-username]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-username]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-sync-client-crt-proxy-password]] [.property-path]##`quarkus.cognito-user-pools.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-cognito-user-pools_section_quarkus-cognito-user-pools-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-max-concurrency]] [.property-path]##`quarkus.cognito-user-pools.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.cognito-user-pools.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-read-timeout]] [.property-path]##`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. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-write-timeout]] [.property-path]##`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. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.cognito-user-pools.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tcp-keep-alive]] [.property-path]##`quarkus.cognito-user-pools.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-protocol]] [.property-path]##`quarkus.cognito-user-pools.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-ssl-provider]] [.property-path]##`quarkus.cognito-user-pools.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-max-streams]] [.property-path]##`quarkus.cognito-user-pools.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-initial-window-size]] [.property-path]##`quarkus.cognito-user-pools.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-enabled]] [.property-path]##`quarkus.cognito-user-pools.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-endpoint]] [.property-path]##`quarkus.cognito-user-pools.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-proxy-non-proxy-hosts]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.cognito-user-pools.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-override]] [.property-path]##`quarkus.cognito-user-pools.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.cognito-user-pools.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_COGNITO_USER_POOLS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-cognito-user-pools_quarkus-cognito-user-pools] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file 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 1bfcda295..e7cde6124 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced.adoc @@ -1,23 +1,19 @@ - -:summaryTableId: quarkus-amazon-dynamodb-enhanced +:summaryTableId: quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-dynamodb-enhanced_configuration]]link:#quarkus-amazon-dynamodb-enhanced_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced-client-extensions]] [.property-path]##`quarkus.dynamodbenhanced.client-extensions`## [.description] -- -List of extensions to load with the enhanced client. +List of extensions to load with the enhanced client -The list should consists of class names which implements `software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClientExtension` interface. ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODBENHANCED_CLIENT_EXTENSIONS+++[] @@ -25,12 +21,11 @@ endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODBENHANCED_CLIENT_EXTENSIONS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced-create-table-schemas]] [.property-path]##`quarkus.dynamodbenhanced.create-table-schemas`## [.description] -- @@ -38,13 +33,18 @@ Whether a `TableSchema` should be created at start up for DynamoDb mappable enti `TableSchema` are cached and can be retrieved later with `TableSchema.fromClass()` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODBENHANCED_CREATE_TABLE_SCHEMAS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODBENHANCED_CREATE_TABLE_SCHEMAS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.adoc new file mode 100644 index 000000000..e7cde6124 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb-enhanced_quarkus.dynamodbenhanced.adoc @@ -0,0 +1,50 @@ +:summaryTableId: quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced-client-extensions]] [.property-path]##`quarkus.dynamodbenhanced.client-extensions`## + +[.description] +-- +List of extensions to load with the enhanced client + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODBENHANCED_CLIENT_EXTENSIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODBENHANCED_CLIENT_EXTENSIONS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb-enhanced_quarkus-dynamodbenhanced-create-table-schemas]] [.property-path]##`quarkus.dynamodbenhanced.create-table-schemas`## + +[.description] +-- +Whether a `TableSchema` should be created at start up for DynamoDb mappable entities annotated with `DynamoDbBean` or `DynamoDbImmutable` + +`TableSchema` are cached and can be retrieved later with `TableSchema.fromClass()` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODBENHANCED_CREATE_TABLE_SCHEMAS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODBENHANCED_CREATE_TABLE_SCHEMAS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc index 6888f707a..6bfbdce88 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-dynamodb +:summaryTableId: quarkus-amazon-dynamodb_quarkus-dynamodb [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-dynamodb_configuration]]link:#quarkus-amazon-dynamodb_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-interceptors]] [.property-path]##`quarkus.dynamodb.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-telemetry-enabled]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-telemetry-enabled[quarkus.dynamodb.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-telemetry-enabled]] [.property-path]##`quarkus.dynamodb.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-type]] [.property-path]##`quarkus.dynamodb.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-type]] [.property-path]##`quarkus.dynamodb.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-shared]] [.property-path]##`quarkus.dynamodb.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-isolated]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-isolated[quarkus.dynamodb.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-isolated]] [.property-path]##`quarkus.dynamodb.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-service-name]] [.property-path]##`quarkus.dynamodb.devservices.service-name`## [.description] -- @@ -146,58 +141,58 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-enable-endpoint-discovery]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-enable-endpoint-discovery[quarkus.dynamodb.enable-endpoint-discovery]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-container-properties-container-properties]] [.property-path]##`quarkus.dynamodb.devservices.container-properties."container-properties"`## [.description] -- -Enable DynamoDB service endpoint discovery. +Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++` +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|boolean -|`false` - - -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."container-properties"]` +-- +|Map +| +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-enable-endpoint-discovery]] [.property-path]##`quarkus.dynamodb.enable-endpoint-discovery`## [.description] -- -Generic properties that are pass for additional container configuration. +Enable DynamoDB service endpoint discovery. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +Environment variable: `+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -| - - -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sdk-aws-sdk-client-configurations[AWS SDK client configurations] +-- +|boolean +|`false` +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-endpoint-override]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-endpoint-override[quarkus.dynamodb.endpoint-override]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-endpoint-override]] [.property-path]##`quarkus.dynamodb.endpoint-override`## +`quarkus.dynamodb."client-name".endpoint-override` [.description] -- @@ -205,19 +200,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-timeout]] [.property-path]##`quarkus.dynamodb.api-call-timeout`## -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-timeout]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-timeout[quarkus.dynamodb.api-call-timeout]` - +`quarkus.dynamodb."client-name".api-call-timeout` [.description] -- @@ -227,19 +223,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-attempt-timeout]] [.property-path]##`quarkus.dynamodb.api-call-attempt-timeout`## -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]` - +`quarkus.dynamodb."client-name".api-call-attempt-timeout` [.description] -- @@ -247,19 +244,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.dynamodb.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.dynamodb."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -267,23 +265,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-region]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-region[quarkus.dynamodb.aws.region]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-region]] [.property-path]##`quarkus.dynamodb.aws.region`## +`quarkus.dynamodb."client-name".aws.region` [.description] -- @@ -300,18 +300,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-type]] [.property-path]##`quarkus.dynamodb.aws.credentials.type`## -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-type]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-type[quarkus.dynamodb.aws.credentials.type]` - +`quarkus.dynamodb."client-name".aws.credentials.type` [.description] -- @@ -340,24 +342,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.dynamodb."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -365,18 +367,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.dynamodb."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -384,79 +388,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.access-key-id`## +`quarkus.dynamodb."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.dynamodb."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.dynamodb."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.dynamodb.aws.credentials.profile-provider.profile-name`## +`quarkus.dynamodb."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -464,23 +476,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.dynamodb."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -488,18 +502,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.dynamodb."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -507,116 +523,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.dynamodb."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-command]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.command`## -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]` - +`quarkus.dynamodb."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.dynamodb.aws.credentials.custom-provider.name`## +`quarkus.dynamodb."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-connection-timeout]] [.property-path]##`quarkus.dynamodb.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -630,36 +650,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -667,35 +686,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -709,36 +728,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -746,94 +764,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-max-connections]] [.property-path]##`quarkus.dynamodb.sync-client.apache.max-connections`## [.description] -- @@ -841,35 +855,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.dynamodb.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -877,52 +891,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.dynamodb.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.endpoint`## [.description] -- @@ -930,178 +944,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-username]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-password]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-connection-max-idle-time[quarkus.dynamodb.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.dynamodb.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-max-concurrency[quarkus.dynamodb.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.dynamodb.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-enabled[quarkus.dynamodb.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-endpoint[quarkus.dynamodb.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1109,58 +1121,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-username]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-username[quarkus.dynamodb.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-username]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-password]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-password[quarkus.dynamodb.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-password]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-async-http-transport-configurations]]link:#quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-max-concurrency]] [.property-path]##`quarkus.dynamodb.async-client.max-concurrency`## [.description] -- @@ -1168,18 +1180,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.dynamodb.async-client.max-pending-connection-acquires`## [.description] -- @@ -1187,18 +1199,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-read-timeout]] [.property-path]##`quarkus.dynamodb.async-client.read-timeout`## [.description] -- @@ -1206,19 +1218,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-write-timeout]] [.property-path]##`quarkus.dynamodb.async-client.write-timeout`## [.description] -- @@ -1226,73 +1237,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-timeout]] [.property-path]##`quarkus.dynamodb.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-max-idle-time]] [.property-path]##`quarkus.dynamodb.async-client.connection-max-idle-time`## [.description] -- @@ -1300,19 +1307,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.dynamodb.async-client.use-idle-connection-reaper`## [.description] -- @@ -1320,53 +1326,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tcp-keep-alive]] [.property-path]##`quarkus.dynamodb.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-protocol]]`link:#quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-protocol[quarkus.dynamodb.async-client.protocol]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-protocol]] [.property-path]##`quarkus.dynamodb.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-ssl-provider]] [.property-path]##`quarkus.dynamodb.async-client.ssl-provider`## [.description] -- @@ -1374,19 +1379,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-max-streams]] [.property-path]##`quarkus.dynamodb.async-client.http2.max-streams`## [.description] -- @@ -1394,18 +1398,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-initial-window-size]] [.property-path]##`quarkus.dynamodb.async-client.http2.initial-window-size`## [.description] -- @@ -1413,18 +1417,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.dynamodb.async-client.http2.health-check-ping-period`## [.description] -- @@ -1432,36 +1436,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-enabled]] [.property-path]##`quarkus.dynamodb.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.async-client.proxy.endpoint`## [.description] -- @@ -1469,36 +1472,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.dynamodb.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1512,36 +1514,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1549,35 +1550,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1591,36 +1592,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1628,52 +1628,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-override]] [.property-path]##`quarkus.dynamodb.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.dynamodb.async-client.event-loop.number-of-threads`## [.description] -- @@ -1681,18 +1681,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.dynamodb.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1702,18 +1702,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.dynamodb.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1721,19 +1721,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-dynamodb_quarkus-dynamodb] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1750,11 +1754,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-dynamodb_quarkus-dynamodb] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb_quarkus.dynamodb.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb_quarkus.dynamodb.adoc new file mode 100644 index 000000000..6bfbdce88 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-dynamodb_quarkus.dynamodb.adoc @@ -0,0 +1,1768 @@ +:summaryTableId: quarkus-amazon-dynamodb_quarkus-dynamodb +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-telemetry-enabled]] [.property-path]##`quarkus.dynamodb.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-type]] [.property-path]##`quarkus.dynamodb.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-type]] [.property-path]##`quarkus.dynamodb.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-isolated]] [.property-path]##`quarkus.dynamodb.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-dynamodb_quarkus-dynamodb-devservices-container-properties-container-properties]] [.property-path]##`quarkus.dynamodb.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-enable-endpoint-discovery]] [.property-path]##`quarkus.dynamodb.enable-endpoint-discovery`## + +[.description] +-- +Enable DynamoDB service endpoint discovery. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ENABLE_ENDPOINT_DISCOVERY+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-endpoint-override]] [.property-path]##`quarkus.dynamodb.endpoint-override`## + +`quarkus.dynamodb."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-timeout]] [.property-path]##`quarkus.dynamodb.api-call-timeout`## + +`quarkus.dynamodb."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-api-call-attempt-timeout]] [.property-path]##`quarkus.dynamodb.api-call-attempt-timeout`## + +`quarkus.dynamodb."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.dynamodb.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.dynamodb."client-name".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_section_quarkus-dynamodb-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-region]] [.property-path]##`quarkus.dynamodb.aws.region`## + +`quarkus.dynamodb."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-type]] [.property-path]##`quarkus.dynamodb.aws.credentials.type`## + +`quarkus.dynamodb."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.dynamodb."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.dynamodb."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.access-key-id`## + +`quarkus.dynamodb."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.secret-access-key`## + +`quarkus.dynamodb."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.dynamodb.aws.credentials.static-provider.session-token`## + +`quarkus.dynamodb."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.dynamodb.aws.credentials.profile-provider.profile-name`## + +`quarkus.dynamodb."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.dynamodb."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.dynamodb."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.process-output-limit`## + +`quarkus.dynamodb."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-process-provider-command]] [.property-path]##`quarkus.dynamodb.aws.credentials.process-provider.command`## + +`quarkus.dynamodb."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.dynamodb.aws.credentials.custom-provider.name`## + +`quarkus.dynamodb."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-connection-timeout]] [.property-path]##`quarkus.dynamodb.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-max-connections]] [.property-path]##`quarkus.dynamodb.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.dynamodb.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.dynamodb.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-username]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-password]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.dynamodb.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.dynamodb.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.dynamodb.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-username]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-sync-client-crt-proxy-password]] [.property-path]##`quarkus.dynamodb.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-dynamodb_section_quarkus-dynamodb-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-max-concurrency]] [.property-path]##`quarkus.dynamodb.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.dynamodb.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-read-timeout]] [.property-path]##`quarkus.dynamodb.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-write-timeout]] [.property-path]##`quarkus.dynamodb.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-timeout]] [.property-path]##`quarkus.dynamodb.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.dynamodb.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tcp-keep-alive]] [.property-path]##`quarkus.dynamodb.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-protocol]] [.property-path]##`quarkus.dynamodb.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-ssl-provider]] [.property-path]##`quarkus.dynamodb.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-max-streams]] [.property-path]##`quarkus.dynamodb.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-initial-window-size]] [.property-path]##`quarkus.dynamodb.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-enabled]] [.property-path]##`quarkus.dynamodb.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-endpoint]] [.property-path]##`quarkus.dynamodb.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.dynamodb.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.dynamodb.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-override]] [.property-path]##`quarkus.dynamodb.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.dynamodb.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-dynamodb_quarkus-dynamodb-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_DYNAMODB_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DYNAMODB_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-dynamodb_quarkus-dynamodb] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-dynamodb_quarkus-dynamodb] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr.adoc index 14a7557a1..a646ec432 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-ecr +:summaryTableId: quarkus-amazon-ecr_quarkus-ecr [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-ecr_configuration]]link:#quarkus-amazon-ecr_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-interceptors]]`link:#quarkus-amazon-ecr_quarkus-ecr-interceptors[quarkus.ecr.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-interceptors]] [.property-path]##`quarkus.ecr.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-telemetry-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-telemetry-enabled[quarkus.ecr.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-telemetry-enabled]] [.property-path]##`quarkus.ecr.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-sync-client-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-type[quarkus.ecr.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-sync-client-type]] [.property-path]##`quarkus.ecr.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-async-client-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-type[quarkus.ecr.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-async-client-type]] [.property-path]##`quarkus.ecr.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-devservices-enabled[quarkus.ecr.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-enabled]] [.property-path]##`quarkus.ecr.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-shared]]`link:#quarkus-amazon-ecr_quarkus-ecr-devservices-shared[quarkus.ecr.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-shared]] [.property-path]##`quarkus.ecr.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-isolated]]`link:#quarkus-amazon-ecr_quarkus-ecr-devservices-isolated[quarkus.ecr.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-isolated]] [.property-path]##`quarkus.ecr.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-service-name]]`link:#quarkus-amazon-ecr_quarkus-ecr-devservices-service-name[quarkus.ecr.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-service-name]] [.property-path]##`quarkus.ecr.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-container-properties-container-properties]]`link:#quarkus-amazon-ecr_quarkus-ecr-devservices-container-properties-container-properties[quarkus.ecr.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ecr.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-ecr_quarkus-ecr-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-endpoint-override]]`link:#quarkus-amazon-ecr_quarkus-ecr-endpoint-override[quarkus.ecr.endpoint-override]` +a| [[quarkus-amazon-ecr_quarkus-ecr-endpoint-override]] [.property-path]##`quarkus.ecr.endpoint-override`## +`quarkus.ecr."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-timeout]] [.property-path]##`quarkus.ecr.api-call-timeout`## -a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-api-call-timeout[quarkus.ecr.api-call-timeout]` - +`quarkus.ecr."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-attempt-timeout]] [.property-path]##`quarkus.ecr.api-call-attempt-timeout`## -a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-attempt-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-api-call-attempt-timeout[quarkus.ecr.api-call-attempt-timeout]` - +`quarkus.ecr."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ecr_quarkus-ecr-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ecr.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-ecr_quarkus-ecr-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-ecr_quarkus-ecr-advanced-use-quarkus-scheduled-executor-service[quarkus.ecr.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.ecr."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_ECR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-aws-services-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-region]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-region[quarkus.ecr.aws.region]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-region]] [.property-path]##`quarkus.ecr.aws.region`## +`quarkus.ecr."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-type]] [.property-path]##`quarkus.ecr.aws.credentials.type`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-type[quarkus.ecr.aws.credentials.type]` - +`quarkus.ecr."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-async-credential-update-enabled[quarkus.ecr.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.ecr."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.ecr.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.ecr."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-access-key-id[quarkus.ecr.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.access-key-id`## +`quarkus.ecr."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-secret-access-key[quarkus.ecr.aws.credentials.static-provider.secret-access-key]` - +`quarkus.ecr."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-session-token[quarkus.ecr.aws.credentials.static-provider.session-token]` - +`quarkus.ecr."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-profile-name[quarkus.ecr.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ecr.aws.credentials.profile-provider.profile-name`## +`quarkus.ecr."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-async-credential-update-enabled[quarkus.ecr.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.ecr."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-credential-refresh-threshold[quarkus.ecr.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.ecr."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-output-limit[quarkus.ecr.aws.credentials.process-provider.process-output-limit]` - +`quarkus.ecr."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-command]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-command[quarkus.ecr.aws.credentials.process-provider.command]` - +`quarkus.ecr."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-name[quarkus.ecr.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ecr.aws.credentials.custom-provider.name`## +`quarkus.ecr."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ecr_quarkus-ecr-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-connection-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-connection-timeout[quarkus.ecr.sync-client.connection-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-connection-timeout]] [.property-path]##`quarkus.ecr.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-socket-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-socket-timeout[quarkus.ecr.sync-client.socket-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-socket-timeout]] [.property-path]##`quarkus.ecr.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-type[quarkus.ecr.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-path[quarkus.ecr.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-type[quarkus.ecr.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-password[quarkus.ecr.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-type[quarkus.ecr.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-path[quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-type[quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-password[quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-acquisition-timeout[quarkus.ecr.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.ecr.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-max-idle-time[quarkus.ecr.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.ecr.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-time-to-live[quarkus.ecr.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.ecr.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-max-connections]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-max-connections[quarkus.ecr.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-max-connections]] [.property-path]##`quarkus.ecr.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-expect-continue-enabled[quarkus.ecr.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-use-idle-connection-reaper[quarkus.ecr.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ecr.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-tcp-keep-alive[quarkus.ecr.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ecr.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-enabled[quarkus.ecr.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-endpoint[quarkus.ecr.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-username]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-username[quarkus.ecr.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-password[quarkus.ecr.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-domain[quarkus.ecr.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-workstation[quarkus.ecr.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.ecr.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-non-proxy-hosts[quarkus.ecr.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-connection-max-idle-time[quarkus.ecr.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ecr.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-max-concurrency[quarkus.ecr.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ecr.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-enabled[quarkus.ecr.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-endpoint[quarkus.ecr.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-username]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-username[quarkus.ecr.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-password[quarkus.ecr.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ecr_quarkus-ecr-async-client-async-http-transport-configurations]]link:#quarkus-amazon-ecr_quarkus-ecr-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-ecr_section_quarkus-ecr-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-concurrency]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-max-concurrency[quarkus.ecr.async-client.max-concurrency]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-concurrency]] [.property-path]##`quarkus.ecr.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-max-pending-connection-acquires[quarkus.ecr.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ecr.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-read-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-read-timeout[quarkus.ecr.async-client.read-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-read-timeout]] [.property-path]##`quarkus.ecr.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-write-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-write-timeout[quarkus.ecr.async-client.write-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-write-timeout]] [.property-path]##`quarkus.ecr.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-connection-timeout[quarkus.ecr.async-client.connection-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-timeout]] [.property-path]##`quarkus.ecr.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-connection-acquisition-timeout[quarkus.ecr.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.ecr.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-time-to-live]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-connection-time-to-live[quarkus.ecr.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-time-to-live]] [.property-path]##`quarkus.ecr.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-max-idle-time]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-connection-max-idle-time[quarkus.ecr.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-max-idle-time]] [.property-path]##`quarkus.ecr.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-use-idle-connection-reaper[quarkus.ecr.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ecr.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tcp-keep-alive]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tcp-keep-alive[quarkus.ecr.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ecr.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-protocol]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-protocol[quarkus.ecr.async-client.protocol]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-protocol]] [.property-path]##`quarkus.ecr.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-ssl-provider]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-ssl-provider[quarkus.ecr.async-client.ssl-provider]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-ssl-provider]] [.property-path]##`quarkus.ecr.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-max-streams]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-http2-max-streams[quarkus.ecr.async-client.http2.max-streams]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-max-streams]] [.property-path]##`quarkus.ecr.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-initial-window-size]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-http2-initial-window-size[quarkus.ecr.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ecr.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-http2-health-check-ping-period[quarkus.ecr.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.ecr.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-enabled]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-enabled[quarkus.ecr.async-client.proxy.enabled]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-enabled]] [.property-path]##`quarkus.ecr.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-endpoint]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-endpoint[quarkus.ecr.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-endpoint]] [.property-path]##`quarkus.ecr.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-non-proxy-hosts[quarkus.ecr.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ecr.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-type[quarkus.ecr.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-path[quarkus.ecr.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-type[quarkus.ecr.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-password[quarkus.ecr.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-type[quarkus.ecr.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-path[quarkus.ecr.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-type[quarkus.ecr.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-password[quarkus.ecr.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-override]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-override[quarkus.ecr.async-client.event-loop.override]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-override]] [.property-path]##`quarkus.ecr.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-number-of-threads[quarkus.ecr.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ecr.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-thread-name-prefix[quarkus.ecr.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.ecr.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-ecr_quarkus-ecr-async-client-advanced-use-future-completion-thread-pool[quarkus.ecr.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.ecr.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-ecr_quarkus-ecr] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-ecr_quarkus-ecr] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr_quarkus.ecr.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr_quarkus.ecr.adoc new file mode 100644 index 000000000..a646ec432 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ecr_quarkus.ecr.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-ecr_quarkus-ecr +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-interceptors]] [.property-path]##`quarkus.ecr.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-telemetry-enabled]] [.property-path]##`quarkus.ecr.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-sync-client-type]] [.property-path]##`quarkus.ecr.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-async-client-type]] [.property-path]##`quarkus.ecr.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-enabled]] [.property-path]##`quarkus.ecr.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-shared]] [.property-path]##`quarkus.ecr.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-isolated]] [.property-path]##`quarkus.ecr.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-service-name]] [.property-path]##`quarkus.ecr.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ecr_quarkus-ecr-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ecr.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-ecr_section_quarkus-ecr]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-endpoint-override]] [.property-path]##`quarkus.ecr.endpoint-override`## + +`quarkus.ecr."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-timeout]] [.property-path]##`quarkus.ecr.api-call-timeout`## + +`quarkus.ecr."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-api-call-attempt-timeout]] [.property-path]##`quarkus.ecr.api-call-attempt-timeout`## + +`quarkus.ecr."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ecr.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.ecr."client-name".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_ECR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-region]] [.property-path]##`quarkus.ecr.aws.region`## + +`quarkus.ecr."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-type]] [.property-path]##`quarkus.ecr.aws.credentials.type`## + +`quarkus.ecr."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.ecr."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.ecr."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.access-key-id`## + +`quarkus.ecr."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.secret-access-key`## + +`quarkus.ecr."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ecr.aws.credentials.static-provider.session-token`## + +`quarkus.ecr."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ecr.aws.credentials.profile-provider.profile-name`## + +`quarkus.ecr."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.ecr."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.ecr."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.process-output-limit`## + +`quarkus.ecr."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ecr.aws.credentials.process-provider.command`## + +`quarkus.ecr."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ecr.aws.credentials.custom-provider.name`## + +`quarkus.ecr."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-connection-timeout]] [.property-path]##`quarkus.ecr.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-socket-timeout]] [.property-path]##`quarkus.ecr.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.ecr.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.ecr.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.ecr.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-max-connections]] [.property-path]##`quarkus.ecr.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ecr.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ecr.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ecr.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ecr.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ecr.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ecr.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ecr_section_quarkus-ecr-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-concurrency]] [.property-path]##`quarkus.ecr.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ecr.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-read-timeout]] [.property-path]##`quarkus.ecr.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-write-timeout]] [.property-path]##`quarkus.ecr.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-timeout]] [.property-path]##`quarkus.ecr.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.ecr.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-time-to-live]] [.property-path]##`quarkus.ecr.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-connection-max-idle-time]] [.property-path]##`quarkus.ecr.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ecr.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ecr.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-protocol]] [.property-path]##`quarkus.ecr.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-ssl-provider]] [.property-path]##`quarkus.ecr.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-max-streams]] [.property-path]##`quarkus.ecr.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ecr.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.ecr.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-enabled]] [.property-path]##`quarkus.ecr.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-endpoint]] [.property-path]##`quarkus.ecr.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ecr.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ecr.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-override]] [.property-path]##`quarkus.ecr.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ecr.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.ecr.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ecr_quarkus-ecr-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.ecr.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ECR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ECR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-ecr_quarkus-ecr] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-ecr_quarkus-ecr] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge.adoc index d434257a0..754fbe4f8 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-eventbridge +:summaryTableId: quarkus-amazon-eventbridge_quarkus-eventbridge [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-eventbridge_configuration]]link:#quarkus-amazon-eventbridge_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-interceptors]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-interceptors[quarkus.eventbridge.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-interceptors]] [.property-path]##`quarkus.eventbridge.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-telemetry-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-telemetry-enabled[quarkus.eventbridge.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-telemetry-enabled]] [.property-path]##`quarkus.eventbridge.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-type[quarkus.eventbridge.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-type]] [.property-path]##`quarkus.eventbridge.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-type[quarkus.eventbridge.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-type]] [.property-path]##`quarkus.eventbridge.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-enabled[quarkus.eventbridge.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-enabled]] [.property-path]##`quarkus.eventbridge.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-shared]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-shared[quarkus.eventbridge.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-shared]] [.property-path]##`quarkus.eventbridge.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-isolated]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-isolated[quarkus.eventbridge.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-isolated]] [.property-path]##`quarkus.eventbridge.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-service-name]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-service-name[quarkus.eventbridge.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-service-name]] [.property-path]##`quarkus.eventbridge.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-container-properties-container-properties]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-container-properties-container-properties[quarkus.eventbridge.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-container-properties-container-properties]] [.property-path]##`quarkus.eventbridge.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-endpoint-override]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-endpoint-override[quarkus.eventbridge.endpoint-override]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-endpoint-override]] [.property-path]##`quarkus.eventbridge.endpoint-override`## +`quarkus.eventbridge."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-timeout]] [.property-path]##`quarkus.eventbridge.api-call-timeout`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-timeout[quarkus.eventbridge.api-call-timeout]` - +`quarkus.eventbridge."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-attempt-timeout]] [.property-path]##`quarkus.eventbridge.api-call-attempt-timeout`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-attempt-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-attempt-timeout[quarkus.eventbridge.api-call-attempt-timeout]` - +`quarkus.eventbridge."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.eventbridge.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-advanced-use-quarkus-scheduled-executor-service[quarkus.eventbridge.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.eventbridge."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_EVENTBRIDGE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-aws-services-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-region]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-region[quarkus.eventbridge.aws.region]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-region]] [.property-path]##`quarkus.eventbridge.aws.region`## +`quarkus.eventbridge."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-type]] [.property-path]##`quarkus.eventbridge.aws.credentials.type`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-type[quarkus.eventbridge.aws.credentials.type]` - +`quarkus.eventbridge."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-async-credential-update-enabled[quarkus.eventbridge.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.eventbridge."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.eventbridge.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.eventbridge."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-access-key-id[quarkus.eventbridge.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.access-key-id`## +`quarkus.eventbridge."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-secret-access-key[quarkus.eventbridge.aws.credentials.static-provider.secret-access-key]` - +`quarkus.eventbridge."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-session-token[quarkus.eventbridge.aws.credentials.static-provider.session-token]` - +`quarkus.eventbridge."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-profile-name[quarkus.eventbridge.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.eventbridge.aws.credentials.profile-provider.profile-name`## +`quarkus.eventbridge."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-async-credential-update-enabled[quarkus.eventbridge.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.eventbridge."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-credential-refresh-threshold[quarkus.eventbridge.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.eventbridge."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-output-limit[quarkus.eventbridge.aws.credentials.process-provider.process-output-limit]` - +`quarkus.eventbridge."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-command]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-command]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-command[quarkus.eventbridge.aws.credentials.process-provider.command]` - +`quarkus.eventbridge."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-name[quarkus.eventbridge.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.eventbridge.aws.credentials.custom-provider.name`## +`quarkus.eventbridge."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-connection-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-connection-timeout[quarkus.eventbridge.sync-client.connection-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-connection-timeout]] [.property-path]##`quarkus.eventbridge.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-socket-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-socket-timeout[quarkus.eventbridge.sync-client.socket-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-socket-timeout]] [.property-path]##`quarkus.eventbridge.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-type[quarkus.eventbridge.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-path[quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-type[quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-password[quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-type[quarkus.eventbridge.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-path[quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-type[quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-password[quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-acquisition-timeout[quarkus.eventbridge.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.eventbridge.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-max-idle-time[quarkus.eventbridge.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-time-to-live[quarkus.eventbridge.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.eventbridge.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-max-connections]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-max-connections[quarkus.eventbridge.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-max-connections]] [.property-path]##`quarkus.eventbridge.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-expect-continue-enabled[quarkus.eventbridge.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-use-idle-connection-reaper[quarkus.eventbridge.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.eventbridge.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-tcp-keep-alive[quarkus.eventbridge.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.eventbridge.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-enabled[quarkus.eventbridge.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-endpoint[quarkus.eventbridge.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-username]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-username[quarkus.eventbridge.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-username]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-password[quarkus.eventbridge.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-password]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-domain[quarkus.eventbridge.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-workstation[quarkus.eventbridge.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.eventbridge.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-non-proxy-hosts[quarkus.eventbridge.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-connection-max-idle-time[quarkus.eventbridge.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-max-concurrency[quarkus.eventbridge.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.eventbridge.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-enabled[quarkus.eventbridge.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-endpoint[quarkus.eventbridge.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-username]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-username[quarkus.eventbridge.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-username]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-password[quarkus.eventbridge.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-password]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-async-http-transport-configurations]]link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-concurrency]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-concurrency[quarkus.eventbridge.async-client.max-concurrency]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-concurrency]] [.property-path]##`quarkus.eventbridge.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-pending-connection-acquires[quarkus.eventbridge.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.eventbridge.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-read-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-read-timeout[quarkus.eventbridge.async-client.read-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-read-timeout]] [.property-path]##`quarkus.eventbridge.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-write-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-write-timeout[quarkus.eventbridge.async-client.write-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-write-timeout]] [.property-path]##`quarkus.eventbridge.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-timeout[quarkus.eventbridge.async-client.connection-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-timeout]] [.property-path]##`quarkus.eventbridge.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-acquisition-timeout[quarkus.eventbridge.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.eventbridge.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-time-to-live]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-time-to-live[quarkus.eventbridge.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-time-to-live]] [.property-path]##`quarkus.eventbridge.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-max-idle-time]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-max-idle-time[quarkus.eventbridge.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-use-idle-connection-reaper[quarkus.eventbridge.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.eventbridge.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tcp-keep-alive]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tcp-keep-alive[quarkus.eventbridge.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tcp-keep-alive]] [.property-path]##`quarkus.eventbridge.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-protocol]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-protocol[quarkus.eventbridge.async-client.protocol]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-protocol]] [.property-path]##`quarkus.eventbridge.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-ssl-provider]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-ssl-provider[quarkus.eventbridge.async-client.ssl-provider]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-ssl-provider]] [.property-path]##`quarkus.eventbridge.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-max-streams]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-max-streams[quarkus.eventbridge.async-client.http2.max-streams]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-max-streams]] [.property-path]##`quarkus.eventbridge.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-initial-window-size]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-initial-window-size[quarkus.eventbridge.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-initial-window-size]] [.property-path]##`quarkus.eventbridge.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-health-check-ping-period[quarkus.eventbridge.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.eventbridge.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-enabled]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-enabled[quarkus.eventbridge.async-client.proxy.enabled]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-enabled]] [.property-path]##`quarkus.eventbridge.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-endpoint]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-endpoint[quarkus.eventbridge.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-non-proxy-hosts[quarkus.eventbridge.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.eventbridge.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-type[quarkus.eventbridge.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-path[quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-type[quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-password[quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-type[quarkus.eventbridge.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-path[quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-type[quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-password[quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-override]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-override[quarkus.eventbridge.async-client.event-loop.override]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-override]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-number-of-threads[quarkus.eventbridge.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-thread-name-prefix[quarkus.eventbridge.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-advanced-use-future-completion-thread-pool[quarkus.eventbridge.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.eventbridge.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-eventbridge_quarkus-eventbridge] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-eventbridge_quarkus-eventbridge] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge_quarkus.eventbridge.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge_quarkus.eventbridge.adoc new file mode 100644 index 000000000..754fbe4f8 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-eventbridge_quarkus.eventbridge.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-eventbridge_quarkus-eventbridge +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-interceptors]] [.property-path]##`quarkus.eventbridge.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-telemetry-enabled]] [.property-path]##`quarkus.eventbridge.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-type]] [.property-path]##`quarkus.eventbridge.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-type]] [.property-path]##`quarkus.eventbridge.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-enabled]] [.property-path]##`quarkus.eventbridge.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-shared]] [.property-path]##`quarkus.eventbridge.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-isolated]] [.property-path]##`quarkus.eventbridge.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-service-name]] [.property-path]##`quarkus.eventbridge.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-eventbridge_quarkus-eventbridge-devservices-container-properties-container-properties]] [.property-path]##`quarkus.eventbridge.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-endpoint-override]] [.property-path]##`quarkus.eventbridge.endpoint-override`## + +`quarkus.eventbridge."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-timeout]] [.property-path]##`quarkus.eventbridge.api-call-timeout`## + +`quarkus.eventbridge."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-api-call-attempt-timeout]] [.property-path]##`quarkus.eventbridge.api-call-attempt-timeout`## + +`quarkus.eventbridge."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.eventbridge.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.eventbridge."client-name".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_EVENTBRIDGE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-region]] [.property-path]##`quarkus.eventbridge.aws.region`## + +`quarkus.eventbridge."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-type]] [.property-path]##`quarkus.eventbridge.aws.credentials.type`## + +`quarkus.eventbridge."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.eventbridge."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.eventbridge."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.access-key-id`## + +`quarkus.eventbridge."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.secret-access-key`## + +`quarkus.eventbridge."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.eventbridge.aws.credentials.static-provider.session-token`## + +`quarkus.eventbridge."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.eventbridge.aws.credentials.profile-provider.profile-name`## + +`quarkus.eventbridge."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.eventbridge."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.eventbridge."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.process-output-limit`## + +`quarkus.eventbridge."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-process-provider-command]] [.property-path]##`quarkus.eventbridge.aws.credentials.process-provider.command`## + +`quarkus.eventbridge."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.eventbridge.aws.credentials.custom-provider.name`## + +`quarkus.eventbridge."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-connection-timeout]] [.property-path]##`quarkus.eventbridge.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-socket-timeout]] [.property-path]##`quarkus.eventbridge.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.eventbridge.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.eventbridge.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-max-connections]] [.property-path]##`quarkus.eventbridge.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.eventbridge.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.eventbridge.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-username]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-password]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.eventbridge.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.eventbridge.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-username]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-sync-client-crt-proxy-password]] [.property-path]##`quarkus.eventbridge.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-eventbridge_section_quarkus-eventbridge-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-concurrency]] [.property-path]##`quarkus.eventbridge.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.eventbridge.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-read-timeout]] [.property-path]##`quarkus.eventbridge.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-write-timeout]] [.property-path]##`quarkus.eventbridge.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-timeout]] [.property-path]##`quarkus.eventbridge.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.eventbridge.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-time-to-live]] [.property-path]##`quarkus.eventbridge.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-connection-max-idle-time]] [.property-path]##`quarkus.eventbridge.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.eventbridge.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tcp-keep-alive]] [.property-path]##`quarkus.eventbridge.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-protocol]] [.property-path]##`quarkus.eventbridge.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-ssl-provider]] [.property-path]##`quarkus.eventbridge.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-max-streams]] [.property-path]##`quarkus.eventbridge.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-initial-window-size]] [.property-path]##`quarkus.eventbridge.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.eventbridge.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-enabled]] [.property-path]##`quarkus.eventbridge.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-endpoint]] [.property-path]##`quarkus.eventbridge.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.eventbridge.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.eventbridge.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-override]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.eventbridge.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-eventbridge_quarkus-eventbridge-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.eventbridge.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_EVENTBRIDGE_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-eventbridge_quarkus-eventbridge] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-eventbridge_quarkus-eventbridge] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc index 3699cc6bd..69f4f087f 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-iam +:summaryTableId: quarkus-amazon-iam_quarkus-iam [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-iam_configuration]]link:#quarkus-amazon-iam_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-interceptors]] [.property-path]##`quarkus.iam.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-telemetry-enabled]]`link:#quarkus-amazon-iam_quarkus-iam-telemetry-enabled[quarkus.iam.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-telemetry-enabled]] [.property-path]##`quarkus.iam.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-sync-client-type]] [.property-path]##`quarkus.iam.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-async-client-type]] [.property-path]##`quarkus.iam.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-shared]] [.property-path]##`quarkus.iam.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-isolated]]`link:#quarkus-amazon-iam_quarkus-iam-devservices-isolated[quarkus.iam.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-isolated]] [.property-path]##`quarkus.iam.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-service-name]] [.property-path]##`quarkus.iam.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-container-properties-container-properties]] [.property-path]##`quarkus.iam.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-iam_quarkus-iam-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-iam_quarkus-iam-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-iam_section_quarkus-iam]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-iam_quarkus-iam-endpoint-override]]`link:#quarkus-amazon-iam_quarkus-iam-endpoint-override[quarkus.iam.endpoint-override]` +a| [[quarkus-amazon-iam_quarkus-iam-endpoint-override]] [.property-path]##`quarkus.iam.endpoint-override`## +`quarkus.iam."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-iam_quarkus-iam-api-call-timeout]] [.property-path]##`quarkus.iam.api-call-timeout`## -a| [[quarkus-amazon-iam_quarkus-iam-api-call-timeout]]`link:#quarkus-amazon-iam_quarkus-iam-api-call-timeout[quarkus.iam.api-call-timeout]` - +`quarkus.iam."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-iam_quarkus-iam-api-call-attempt-timeout]] [.property-path]##`quarkus.iam.api-call-attempt-timeout`## -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]` - +`quarkus.iam."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-iam_quarkus-iam-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.iam.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.iam."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-iam_section_quarkus-iam-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-iam_quarkus-iam-aws-region]]`link:#quarkus-amazon-iam_quarkus-iam-aws-region[quarkus.iam.aws.region]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-region]] [.property-path]##`quarkus.iam.aws.region`## +`quarkus.iam."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-type]] [.property-path]##`quarkus.iam.aws.credentials.type`## -a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-type]]`link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-type[quarkus.iam.aws.credentials.type]` - +`quarkus.iam."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.iam.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.iam."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.iam.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.iam."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.access-key-id`## +`quarkus.iam."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.iam."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.iam."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-iam_quarkus-iam-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.iam.aws.credentials.profile-provider.profile-name`## +`quarkus.iam."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.iam."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.iam."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.iam."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-command]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.command`## -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]` - +`quarkus.iam."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-iam_quarkus-iam-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-iam_quarkus-iam-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.iam.aws.credentials.custom-provider.name`## +`quarkus.iam."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-iam_quarkus-iam-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-iam_quarkus-iam-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-connection-timeout]] [.property-path]##`quarkus.iam.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-iam_quarkus-iam-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-iam_quarkus-iam-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-max-connections]] [.property-path]##`quarkus.iam.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.iam.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.iam.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-username]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-password]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-iam_quarkus-iam-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-connection-max-idle-time[quarkus.iam.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.iam.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-max-concurrency[quarkus.iam.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.iam.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-enabled[quarkus.iam.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-endpoint[quarkus.iam.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-username]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-username[quarkus.iam.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-username]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-password]]`link:#quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-password[quarkus.iam.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-password]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-iam_quarkus-iam-async-client-async-http-transport-configurations]]link:#quarkus-amazon-iam_quarkus-iam-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-iam_section_quarkus-iam-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-max-concurrency]] [.property-path]##`quarkus.iam.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.iam.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-read-timeout]] [.property-path]##`quarkus.iam.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-write-timeout]] [.property-path]##`quarkus.iam.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-timeout]] [.property-path]##`quarkus.iam.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-max-idle-time]] [.property-path]##`quarkus.iam.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.iam.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tcp-keep-alive]] [.property-path]##`quarkus.iam.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-iam_quarkus-iam-async-client-protocol]]`link:#quarkus-amazon-iam_quarkus-iam-async-client-protocol[quarkus.iam.async-client.protocol]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-protocol]] [.property-path]##`quarkus.iam.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-ssl-provider]] [.property-path]##`quarkus.iam.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-max-streams]] [.property-path]##`quarkus.iam.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-initial-window-size]] [.property-path]##`quarkus.iam.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.iam.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-enabled]] [.property-path]##`quarkus.iam.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-endpoint]] [.property-path]##`quarkus.iam.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.iam.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-override]] [.property-path]##`quarkus.iam.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.iam.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.iam.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-iam_quarkus-iam-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.iam.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-iam_quarkus-iam] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-iam_quarkus-iam] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-iam_quarkus.iam.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam_quarkus.iam.adoc new file mode 100644 index 000000000..69f4f087f --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-iam_quarkus.iam.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-iam_quarkus-iam +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-telemetry-enabled]] [.property-path]##`quarkus.iam.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-sync-client-type]] [.property-path]##`quarkus.iam.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-async-client-type]] [.property-path]##`quarkus.iam.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-isolated]] [.property-path]##`quarkus.iam.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-iam_quarkus-iam-devservices-container-properties-container-properties]] [.property-path]##`quarkus.iam.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-iam_section_quarkus-iam]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-endpoint-override]] [.property-path]##`quarkus.iam.endpoint-override`## + +`quarkus.iam."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-iam_quarkus-iam-api-call-timeout]] [.property-path]##`quarkus.iam.api-call-timeout`## + +`quarkus.iam."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-iam_quarkus-iam-api-call-attempt-timeout]] [.property-path]##`quarkus.iam.api-call-attempt-timeout`## + +`quarkus.iam."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-iam_quarkus-iam-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.iam.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.iam."client-name".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_section_quarkus-iam-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-region]] [.property-path]##`quarkus.iam.aws.region`## + +`quarkus.iam."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-type]] [.property-path]##`quarkus.iam.aws.credentials.type`## + +`quarkus.iam."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.iam.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.iam."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.iam.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.iam."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.access-key-id`## + +`quarkus.iam."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.secret-access-key`## + +`quarkus.iam."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.iam.aws.credentials.static-provider.session-token`## + +`quarkus.iam."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.iam.aws.credentials.profile-provider.profile-name`## + +`quarkus.iam."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.iam."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.iam."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.process-output-limit`## + +`quarkus.iam."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-process-provider-command]] [.property-path]##`quarkus.iam.aws.credentials.process-provider.command`## + +`quarkus.iam."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-iam_section_quarkus-iam-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.iam.aws.credentials.custom-provider.name`## + +`quarkus.iam."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-connection-timeout]] [.property-path]##`quarkus.iam.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-max-connections]] [.property-path]##`quarkus.iam.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.iam.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.iam.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-username]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-password]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.iam.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-iam_section_quarkus-iam-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.iam.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.iam.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-username]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-sync-client-crt-proxy-password]] [.property-path]##`quarkus.iam.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-iam_section_quarkus-iam-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-max-concurrency]] [.property-path]##`quarkus.iam.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.iam.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-read-timeout]] [.property-path]##`quarkus.iam.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-write-timeout]] [.property-path]##`quarkus.iam.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-timeout]] [.property-path]##`quarkus.iam.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.iam.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tcp-keep-alive]] [.property-path]##`quarkus.iam.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-protocol]] [.property-path]##`quarkus.iam.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-ssl-provider]] [.property-path]##`quarkus.iam.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-max-streams]] [.property-path]##`quarkus.iam.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-initial-window-size]] [.property-path]##`quarkus.iam.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-enabled]] [.property-path]##`quarkus.iam.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-endpoint]] [.property-path]##`quarkus.iam.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.iam.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.iam.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-override]] [.property-path]##`quarkus.iam.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.iam.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-iam_quarkus-iam-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_IAM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_IAM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-iam_quarkus-iam] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-iam_quarkus-iam] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector.adoc index ed35a8231..199bfdc29 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-inspector +:summaryTableId: quarkus-amazon-inspector_quarkus-inspector [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-inspector_configuration]]link:#quarkus-amazon-inspector_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-interceptors]]`link:#quarkus-amazon-inspector_quarkus-inspector-interceptors[quarkus.inspector.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-interceptors]] [.property-path]##`quarkus.inspector.interceptors`## [.description] -- @@ -19,75 +16,166 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-telemetry-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-telemetry-enabled[quarkus.inspector.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-telemetry-enabled]] [.property-path]##`quarkus.inspector.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-sync-client-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-type[quarkus.inspector.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-sync-client-type]] [.property-path]##`quarkus.inspector.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-async-client-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-type[quarkus.inspector.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-async-client-type]] [.property-path]##`quarkus.inspector.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` -h|[[quarkus-amazon-inspector_quarkus-inspector-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-sdk-aws-sdk-client-configurations[AWS SDK client configurations] +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-enabled]] [.property-path]##`quarkus.inspector.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-shared]] [.property-path]##`quarkus.inspector.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-isolated]] [.property-path]##`quarkus.inspector.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-service-name]] [.property-path]##`quarkus.inspector.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-container-properties-container-properties]] [.property-path]##`quarkus.inspector.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-inspector_section_quarkus-inspector]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-endpoint-override]]`link:#quarkus-amazon-inspector_quarkus-inspector-endpoint-override[quarkus.inspector.endpoint-override]` +a| [[quarkus-amazon-inspector_quarkus-inspector-endpoint-override]] [.property-path]##`quarkus.inspector.endpoint-override`## +`quarkus.inspector."client-name".endpoint-override` [.description] -- @@ -95,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-timeout]] [.property-path]##`quarkus.inspector.api-call-timeout`## -a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-api-call-timeout[quarkus.inspector.api-call-timeout]` - +`quarkus.inspector."client-name".api-call-timeout` [.description] -- @@ -117,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-attempt-timeout]] [.property-path]##`quarkus.inspector.api-call-attempt-timeout`## -a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-attempt-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-api-call-attempt-timeout[quarkus.inspector.api-call-attempt-timeout]` - +`quarkus.inspector."client-name".api-call-attempt-timeout` [.description] -- @@ -137,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-inspector_quarkus-inspector-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.inspector.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-inspector_quarkus-inspector-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-inspector_quarkus-inspector-advanced-use-quarkus-scheduled-executor-service[quarkus.inspector.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.inspector."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -157,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_INSPECTOR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-aws-services-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-region]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-region[quarkus.inspector.aws.region]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-region]] [.property-path]##`quarkus.inspector.aws.region`## +`quarkus.inspector."client-name".aws.region` [.description] -- @@ -190,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-type]] [.property-path]##`quarkus.inspector.aws.credentials.type`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-type[quarkus.inspector.aws.credentials.type]` - +`quarkus.inspector."client-name".aws.credentials.type` [.description] -- @@ -230,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-async-credential-update-enabled[quarkus.inspector.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.inspector."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -255,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.inspector.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.inspector."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -274,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-access-key-id[quarkus.inspector.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.access-key-id`## +`quarkus.inspector."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-secret-access-key[quarkus.inspector.aws.credentials.static-provider.secret-access-key]` - +`quarkus.inspector."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-session-token[quarkus.inspector.aws.credentials.static-provider.session-token]` - +`quarkus.inspector."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-profile-name[quarkus.inspector.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.inspector.aws.credentials.profile-provider.profile-name`## +`quarkus.inspector."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -354,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-async-credential-update-enabled[quarkus.inspector.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.inspector."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -378,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-credential-refresh-threshold[quarkus.inspector.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.inspector."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -397,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-output-limit[quarkus.inspector.aws.credentials.process-provider.process-output-limit]` - +`quarkus.inspector."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-command]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-command]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-command[quarkus.inspector.aws.credentials.process-provider.command]` - +`quarkus.inspector."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-name[quarkus.inspector.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.inspector.aws.credentials.custom-provider.name`## +`quarkus.inspector."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector_quarkus-inspector-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-connection-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-connection-timeout[quarkus.inspector.sync-client.connection-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-connection-timeout]] [.property-path]##`quarkus.inspector.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-socket-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-socket-timeout[quarkus.inspector.sync-client.socket-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-socket-timeout]] [.property-path]##`quarkus.inspector.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-type[quarkus.inspector.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -520,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-path[quarkus.inspector.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-type[quarkus.inspector.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -557,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-password[quarkus.inspector.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-type[quarkus.inspector.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -599,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-path[quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-type[quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -636,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-password[quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-acquisition-timeout[quarkus.inspector.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-max-idle-time[quarkus.inspector.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.inspector.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-time-to-live[quarkus.inspector.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.inspector.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-max-connections]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-max-connections[quarkus.inspector.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-max-connections]] [.property-path]##`quarkus.inspector.sync-client.apache.max-connections`## [.description] -- @@ -731,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-expect-continue-enabled[quarkus.inspector.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-use-idle-connection-reaper[quarkus.inspector.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -767,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-tcp-keep-alive[quarkus.inspector.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.inspector.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-enabled[quarkus.inspector.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-endpoint[quarkus.inspector.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.endpoint`## [.description] -- @@ -820,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-username]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-username[quarkus.inspector.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-username]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-password[quarkus.inspector.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-password]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-domain[quarkus.inspector.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-workstation[quarkus.inspector.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.inspector.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-non-proxy-hosts[quarkus.inspector.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-connection-max-idle-time[quarkus.inspector.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.inspector.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-max-concurrency[quarkus.inspector.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.inspector.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-enabled[quarkus.inspector.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-endpoint[quarkus.inspector.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.endpoint`## [.description] -- @@ -999,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-username]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-username[quarkus.inspector.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-username]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-password[quarkus.inspector.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-password]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector_quarkus-inspector-async-client-async-http-transport-configurations]]link:#quarkus-amazon-inspector_quarkus-inspector-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-inspector_section_quarkus-inspector-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-concurrency]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-max-concurrency[quarkus.inspector.async-client.max-concurrency]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-concurrency]] [.property-path]##`quarkus.inspector.async-client.max-concurrency`## [.description] -- @@ -1058,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-max-pending-connection-acquires[quarkus.inspector.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.inspector.async-client.max-pending-connection-acquires`## [.description] -- @@ -1077,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-read-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-read-timeout[quarkus.inspector.async-client.read-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-read-timeout]] [.property-path]##`quarkus.inspector.async-client.read-timeout`## [.description] -- @@ -1096,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-write-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-write-timeout[quarkus.inspector.async-client.write-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-write-timeout]] [.property-path]##`quarkus.inspector.async-client.write-timeout`## [.description] -- @@ -1116,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-connection-timeout[quarkus.inspector.async-client.connection-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-timeout]] [.property-path]##`quarkus.inspector.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-connection-acquisition-timeout[quarkus.inspector.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-time-to-live]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-connection-time-to-live[quarkus.inspector.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-time-to-live]] [.property-path]##`quarkus.inspector.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-max-idle-time]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-connection-max-idle-time[quarkus.inspector.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-max-idle-time]] [.property-path]##`quarkus.inspector.async-client.connection-max-idle-time`## [.description] -- @@ -1190,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-use-idle-connection-reaper[quarkus.inspector.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector.async-client.use-idle-connection-reaper`## [.description] -- @@ -1210,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tcp-keep-alive]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tcp-keep-alive[quarkus.inspector.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tcp-keep-alive]] [.property-path]##`quarkus.inspector.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-protocol]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-protocol[quarkus.inspector.async-client.protocol]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-protocol]] [.property-path]##`quarkus.inspector.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-ssl-provider]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-ssl-provider[quarkus.inspector.async-client.ssl-provider]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-ssl-provider]] [.property-path]##`quarkus.inspector.async-client.ssl-provider`## [.description] -- @@ -1264,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-max-streams]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-http2-max-streams[quarkus.inspector.async-client.http2.max-streams]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-max-streams]] [.property-path]##`quarkus.inspector.async-client.http2.max-streams`## [.description] -- @@ -1284,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-initial-window-size]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-http2-initial-window-size[quarkus.inspector.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-initial-window-size]] [.property-path]##`quarkus.inspector.async-client.http2.initial-window-size`## [.description] -- @@ -1303,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-http2-health-check-ping-period[quarkus.inspector.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.inspector.async-client.http2.health-check-ping-period`## [.description] -- @@ -1322,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-enabled]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-enabled[quarkus.inspector.async-client.proxy.enabled]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-enabled]] [.property-path]##`quarkus.inspector.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-endpoint]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-endpoint[quarkus.inspector.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-endpoint]] [.property-path]##`quarkus.inspector.async-client.proxy.endpoint`## [.description] -- @@ -1359,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-non-proxy-hosts[quarkus.inspector.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-type[quarkus.inspector.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1402,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-path[quarkus.inspector.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-type[quarkus.inspector.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1439,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-password[quarkus.inspector.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-type[quarkus.inspector.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1481,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-path[quarkus.inspector.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-type[quarkus.inspector.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1518,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-password[quarkus.inspector.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-override]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-override[quarkus.inspector.async-client.event-loop.override]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-override]] [.property-path]##`quarkus.inspector.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-number-of-threads[quarkus.inspector.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.inspector.async-client.event-loop.number-of-threads`## [.description] -- @@ -1571,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-thread-name-prefix[quarkus.inspector.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.inspector.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1592,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-inspector_quarkus-inspector-async-client-advanced-use-future-completion-thread-pool[quarkus.inspector.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.inspector.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1611,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-inspector_quarkus-inspector] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1640,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-inspector_quarkus-inspector] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2.adoc index 395c176d6..b586e81bf 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-inspector22 +:summaryTableId: quarkus-amazon-inspector2_quarkus-inspector2 [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-inspector2_configuration]]link:#quarkus-amazon-inspector2_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-interceptors]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-interceptors[quarkus.inspector2.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-interceptors]] [.property-path]##`quarkus.inspector2.interceptors`## [.description] -- @@ -19,75 +16,166 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-telemetry-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-telemetry-enabled[quarkus.inspector2.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-telemetry-enabled]] [.property-path]##`quarkus.inspector2.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-type[quarkus.inspector2.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-type]] [.property-path]##`quarkus.inspector2.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-type[quarkus.inspector2.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-type]] [.property-path]##`quarkus.inspector2.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` -h|[[quarkus-amazon-inspector2_quarkus-inspector2-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-sdk-aws-sdk-client-configurations[AWS SDK client configurations] +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-enabled]] [.property-path]##`quarkus.inspector2.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-shared]] [.property-path]##`quarkus.inspector2.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-isolated]] [.property-path]##`quarkus.inspector2.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-service-name]] [.property-path]##`quarkus.inspector2.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-container-properties-container-properties]] [.property-path]##`quarkus.inspector2.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-endpoint-override]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-endpoint-override[quarkus.inspector2.endpoint-override]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-endpoint-override]] [.property-path]##`quarkus.inspector2.endpoint-override`## +`quarkus.inspector2."client-name".endpoint-override` [.description] -- @@ -95,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-timeout]] [.property-path]##`quarkus.inspector2.api-call-timeout`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-api-call-timeout[quarkus.inspector2.api-call-timeout]` - +`quarkus.inspector2."client-name".api-call-timeout` [.description] -- @@ -117,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-attempt-timeout]] [.property-path]##`quarkus.inspector2.api-call-attempt-timeout`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-attempt-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-api-call-attempt-timeout[quarkus.inspector2.api-call-attempt-timeout]` - +`quarkus.inspector2."client-name".api-call-attempt-timeout` [.description] -- @@ -137,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.inspector2.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-advanced-use-quarkus-scheduled-executor-service[quarkus.inspector2.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.inspector2."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -157,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_INSPECTOR2_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-aws-services-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-region]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-region[quarkus.inspector2.aws.region]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-region]] [.property-path]##`quarkus.inspector2.aws.region`## +`quarkus.inspector2."client-name".aws.region` [.description] -- @@ -190,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-type]] [.property-path]##`quarkus.inspector2.aws.credentials.type`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-type[quarkus.inspector2.aws.credentials.type]` - +`quarkus.inspector2."client-name".aws.credentials.type` [.description] -- @@ -230,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-async-credential-update-enabled[quarkus.inspector2.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.inspector2."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -255,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.inspector2.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.inspector2."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -274,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-access-key-id[quarkus.inspector2.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.access-key-id`## +`quarkus.inspector2."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-secret-access-key[quarkus.inspector2.aws.credentials.static-provider.secret-access-key]` - +`quarkus.inspector2."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-session-token[quarkus.inspector2.aws.credentials.static-provider.session-token]` - +`quarkus.inspector2."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-profile-name[quarkus.inspector2.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.inspector2.aws.credentials.profile-provider.profile-name`## +`quarkus.inspector2."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -354,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-async-credential-update-enabled[quarkus.inspector2.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.inspector2."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -378,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-credential-refresh-threshold[quarkus.inspector2.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.inspector2."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -397,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-output-limit[quarkus.inspector2.aws.credentials.process-provider.process-output-limit]` - +`quarkus.inspector2."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-command]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-command]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-command[quarkus.inspector2.aws.credentials.process-provider.command]` - +`quarkus.inspector2."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-name[quarkus.inspector2.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.inspector2.aws.credentials.custom-provider.name`## +`quarkus.inspector2."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-connection-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-connection-timeout[quarkus.inspector2.sync-client.connection-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-connection-timeout]] [.property-path]##`quarkus.inspector2.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-socket-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-socket-timeout[quarkus.inspector2.sync-client.socket-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-socket-timeout]] [.property-path]##`quarkus.inspector2.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-type[quarkus.inspector2.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -520,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-path[quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-type[quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -557,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-password[quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-type[quarkus.inspector2.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -599,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-path[quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-type[quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -636,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-password[quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-acquisition-timeout[quarkus.inspector2.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector2.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-max-idle-time[quarkus.inspector2.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-time-to-live[quarkus.inspector2.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.inspector2.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-max-connections]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-max-connections[quarkus.inspector2.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-max-connections]] [.property-path]##`quarkus.inspector2.sync-client.apache.max-connections`## [.description] -- @@ -731,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-expect-continue-enabled[quarkus.inspector2.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-use-idle-connection-reaper[quarkus.inspector2.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector2.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -767,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-tcp-keep-alive[quarkus.inspector2.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.inspector2.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-enabled[quarkus.inspector2.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-endpoint[quarkus.inspector2.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.endpoint`## [.description] -- @@ -820,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-username]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-username[quarkus.inspector2.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-username]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-password[quarkus.inspector2.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-password]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-domain[quarkus.inspector2.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-workstation[quarkus.inspector2.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.inspector2.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-non-proxy-hosts[quarkus.inspector2.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-connection-max-idle-time[quarkus.inspector2.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-max-concurrency[quarkus.inspector2.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.inspector2.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-enabled[quarkus.inspector2.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-endpoint[quarkus.inspector2.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.endpoint`## [.description] -- @@ -999,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-username]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-username[quarkus.inspector2.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-username]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-password[quarkus.inspector2.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-password]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-inspector2_quarkus-inspector2-async-client-async-http-transport-configurations]]link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-concurrency]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-concurrency[quarkus.inspector2.async-client.max-concurrency]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-concurrency]] [.property-path]##`quarkus.inspector2.async-client.max-concurrency`## [.description] -- @@ -1058,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-pending-connection-acquires[quarkus.inspector2.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.inspector2.async-client.max-pending-connection-acquires`## [.description] -- @@ -1077,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-read-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-read-timeout[quarkus.inspector2.async-client.read-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-read-timeout]] [.property-path]##`quarkus.inspector2.async-client.read-timeout`## [.description] -- @@ -1096,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-write-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-write-timeout[quarkus.inspector2.async-client.write-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-write-timeout]] [.property-path]##`quarkus.inspector2.async-client.write-timeout`## [.description] -- @@ -1116,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-timeout[quarkus.inspector2.async-client.connection-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-timeout]] [.property-path]##`quarkus.inspector2.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-acquisition-timeout[quarkus.inspector2.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector2.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-time-to-live]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-time-to-live[quarkus.inspector2.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-time-to-live]] [.property-path]##`quarkus.inspector2.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-max-idle-time]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-max-idle-time[quarkus.inspector2.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.async-client.connection-max-idle-time`## [.description] -- @@ -1190,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-use-idle-connection-reaper[quarkus.inspector2.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector2.async-client.use-idle-connection-reaper`## [.description] -- @@ -1210,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tcp-keep-alive]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tcp-keep-alive[quarkus.inspector2.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tcp-keep-alive]] [.property-path]##`quarkus.inspector2.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-protocol]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-protocol[quarkus.inspector2.async-client.protocol]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-protocol]] [.property-path]##`quarkus.inspector2.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-ssl-provider]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-ssl-provider[quarkus.inspector2.async-client.ssl-provider]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-ssl-provider]] [.property-path]##`quarkus.inspector2.async-client.ssl-provider`## [.description] -- @@ -1264,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-max-streams]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-max-streams[quarkus.inspector2.async-client.http2.max-streams]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-max-streams]] [.property-path]##`quarkus.inspector2.async-client.http2.max-streams`## [.description] -- @@ -1284,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-initial-window-size]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-initial-window-size[quarkus.inspector2.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-initial-window-size]] [.property-path]##`quarkus.inspector2.async-client.http2.initial-window-size`## [.description] -- @@ -1303,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-health-check-ping-period[quarkus.inspector2.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.inspector2.async-client.http2.health-check-ping-period`## [.description] -- @@ -1322,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-enabled]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-enabled[quarkus.inspector2.async-client.proxy.enabled]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-enabled]] [.property-path]##`quarkus.inspector2.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-endpoint]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-endpoint[quarkus.inspector2.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-endpoint]] [.property-path]##`quarkus.inspector2.async-client.proxy.endpoint`## [.description] -- @@ -1359,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-non-proxy-hosts[quarkus.inspector2.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector2.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-type[quarkus.inspector2.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1402,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-path[quarkus.inspector2.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-type[quarkus.inspector2.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1439,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-password[quarkus.inspector2.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-type[quarkus.inspector2.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1481,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-path[quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-type[quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1518,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-password[quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-override]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-override[quarkus.inspector2.async-client.event-loop.override]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-override]] [.property-path]##`quarkus.inspector2.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-number-of-threads[quarkus.inspector2.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.inspector2.async-client.event-loop.number-of-threads`## [.description] -- @@ -1571,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-thread-name-prefix[quarkus.inspector2.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.inspector2.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1592,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-inspector2_quarkus-inspector2-async-client-advanced-use-future-completion-thread-pool[quarkus.inspector2.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.inspector2.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1611,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-inspector2_quarkus-inspector2] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1640,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-inspector2_quarkus-inspector2] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2_quarkus.inspector2.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2_quarkus.inspector2.adoc new file mode 100644 index 000000000..b586e81bf --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector2_quarkus.inspector2.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-inspector2_quarkus-inspector2 +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-interceptors]] [.property-path]##`quarkus.inspector2.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-telemetry-enabled]] [.property-path]##`quarkus.inspector2.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-type]] [.property-path]##`quarkus.inspector2.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-type]] [.property-path]##`quarkus.inspector2.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-enabled]] [.property-path]##`quarkus.inspector2.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-shared]] [.property-path]##`quarkus.inspector2.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-isolated]] [.property-path]##`quarkus.inspector2.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-service-name]] [.property-path]##`quarkus.inspector2.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector2_quarkus-inspector2-devservices-container-properties-container-properties]] [.property-path]##`quarkus.inspector2.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-endpoint-override]] [.property-path]##`quarkus.inspector2.endpoint-override`## + +`quarkus.inspector2."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-timeout]] [.property-path]##`quarkus.inspector2.api-call-timeout`## + +`quarkus.inspector2."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-api-call-attempt-timeout]] [.property-path]##`quarkus.inspector2.api-call-attempt-timeout`## + +`quarkus.inspector2."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.inspector2.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.inspector2."client-name".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_INSPECTOR2_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-region]] [.property-path]##`quarkus.inspector2.aws.region`## + +`quarkus.inspector2."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-type]] [.property-path]##`quarkus.inspector2.aws.credentials.type`## + +`quarkus.inspector2."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.inspector2."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.inspector2."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.access-key-id`## + +`quarkus.inspector2."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.secret-access-key`## + +`quarkus.inspector2."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.inspector2.aws.credentials.static-provider.session-token`## + +`quarkus.inspector2."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.inspector2.aws.credentials.profile-provider.profile-name`## + +`quarkus.inspector2."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.inspector2."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.inspector2."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.process-output-limit`## + +`quarkus.inspector2."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-process-provider-command]] [.property-path]##`quarkus.inspector2.aws.credentials.process-provider.command`## + +`quarkus.inspector2."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.inspector2.aws.credentials.custom-provider.name`## + +`quarkus.inspector2."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-connection-timeout]] [.property-path]##`quarkus.inspector2.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-socket-timeout]] [.property-path]##`quarkus.inspector2.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector2.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.inspector2.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-max-connections]] [.property-path]##`quarkus.inspector2.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector2.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.inspector2.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-username]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-password]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector2.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.inspector2.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-username]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-sync-client-crt-proxy-password]] [.property-path]##`quarkus.inspector2.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-inspector2_section_quarkus-inspector2-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-concurrency]] [.property-path]##`quarkus.inspector2.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.inspector2.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-read-timeout]] [.property-path]##`quarkus.inspector2.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-write-timeout]] [.property-path]##`quarkus.inspector2.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-timeout]] [.property-path]##`quarkus.inspector2.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector2.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-time-to-live]] [.property-path]##`quarkus.inspector2.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-connection-max-idle-time]] [.property-path]##`quarkus.inspector2.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector2.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tcp-keep-alive]] [.property-path]##`quarkus.inspector2.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-protocol]] [.property-path]##`quarkus.inspector2.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-ssl-provider]] [.property-path]##`quarkus.inspector2.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-max-streams]] [.property-path]##`quarkus.inspector2.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-initial-window-size]] [.property-path]##`quarkus.inspector2.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.inspector2.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-enabled]] [.property-path]##`quarkus.inspector2.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-endpoint]] [.property-path]##`quarkus.inspector2.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector2.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector2.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-override]] [.property-path]##`quarkus.inspector2.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.inspector2.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.inspector2.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector2_quarkus-inspector2-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.inspector2.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR2_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-inspector2_quarkus-inspector2] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-inspector2_quarkus-inspector2] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector_quarkus.inspector.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector_quarkus.inspector.adoc new file mode 100644 index 000000000..199bfdc29 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-inspector_quarkus.inspector.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-inspector_quarkus-inspector +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-interceptors]] [.property-path]##`quarkus.inspector.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-telemetry-enabled]] [.property-path]##`quarkus.inspector.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-sync-client-type]] [.property-path]##`quarkus.inspector.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-async-client-type]] [.property-path]##`quarkus.inspector.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-enabled]] [.property-path]##`quarkus.inspector.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-shared]] [.property-path]##`quarkus.inspector.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-isolated]] [.property-path]##`quarkus.inspector.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-service-name]] [.property-path]##`quarkus.inspector.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-inspector_quarkus-inspector-devservices-container-properties-container-properties]] [.property-path]##`quarkus.inspector.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-inspector_section_quarkus-inspector]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-endpoint-override]] [.property-path]##`quarkus.inspector.endpoint-override`## + +`quarkus.inspector."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-timeout]] [.property-path]##`quarkus.inspector.api-call-timeout`## + +`quarkus.inspector."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-api-call-attempt-timeout]] [.property-path]##`quarkus.inspector.api-call-attempt-timeout`## + +`quarkus.inspector."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.inspector.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.inspector."client-name".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_INSPECTOR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-region]] [.property-path]##`quarkus.inspector.aws.region`## + +`quarkus.inspector."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-type]] [.property-path]##`quarkus.inspector.aws.credentials.type`## + +`quarkus.inspector."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.inspector."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.inspector."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.access-key-id`## + +`quarkus.inspector."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.secret-access-key`## + +`quarkus.inspector."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.inspector.aws.credentials.static-provider.session-token`## + +`quarkus.inspector."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.inspector.aws.credentials.profile-provider.profile-name`## + +`quarkus.inspector."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.inspector."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.inspector."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.process-output-limit`## + +`quarkus.inspector."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-process-provider-command]] [.property-path]##`quarkus.inspector.aws.credentials.process-provider.command`## + +`quarkus.inspector."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.inspector.aws.credentials.custom-provider.name`## + +`quarkus.inspector."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-connection-timeout]] [.property-path]##`quarkus.inspector.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-socket-timeout]] [.property-path]##`quarkus.inspector.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.inspector.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.inspector.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-max-connections]] [.property-path]##`quarkus.inspector.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.inspector.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-username]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-password]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.inspector.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.inspector.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-username]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-sync-client-crt-proxy-password]] [.property-path]##`quarkus.inspector.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-inspector_section_quarkus-inspector-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-concurrency]] [.property-path]##`quarkus.inspector.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.inspector.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-read-timeout]] [.property-path]##`quarkus.inspector.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-write-timeout]] [.property-path]##`quarkus.inspector.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-timeout]] [.property-path]##`quarkus.inspector.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.inspector.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-time-to-live]] [.property-path]##`quarkus.inspector.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-connection-max-idle-time]] [.property-path]##`quarkus.inspector.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.inspector.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tcp-keep-alive]] [.property-path]##`quarkus.inspector.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-protocol]] [.property-path]##`quarkus.inspector.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-ssl-provider]] [.property-path]##`quarkus.inspector.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-max-streams]] [.property-path]##`quarkus.inspector.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-initial-window-size]] [.property-path]##`quarkus.inspector.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.inspector.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-enabled]] [.property-path]##`quarkus.inspector.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-endpoint]] [.property-path]##`quarkus.inspector.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.inspector.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.inspector.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-override]] [.property-path]##`quarkus.inspector.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.inspector.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.inspector.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-inspector_quarkus-inspector-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.inspector.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_INSPECTOR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INSPECTOR_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-inspector_quarkus-inspector] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-inspector_quarkus-inspector] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis.adoc index d882f7a2c..6842697dd 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-kinesis +:summaryTableId: quarkus-amazon-kinesis_quarkus-kinesis [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-kinesis_configuration]]link:#quarkus-amazon-kinesis_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-interceptors]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-interceptors[quarkus.kinesis.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-interceptors]] [.property-path]##`quarkus.kinesis.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-telemetry-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-telemetry-enabled[quarkus.kinesis.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-telemetry-enabled]] [.property-path]##`quarkus.kinesis.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-type[quarkus.kinesis.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-type]] [.property-path]##`quarkus.kinesis.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-type[quarkus.kinesis.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-type]] [.property-path]##`quarkus.kinesis.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-devservices-enabled[quarkus.kinesis.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-enabled]] [.property-path]##`quarkus.kinesis.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-shared]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-devservices-shared[quarkus.kinesis.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-shared]] [.property-path]##`quarkus.kinesis.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-isolated]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-devservices-isolated[quarkus.kinesis.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-isolated]] [.property-path]##`quarkus.kinesis.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-service-name]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-devservices-service-name[quarkus.kinesis.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-service-name]] [.property-path]##`quarkus.kinesis.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-container-properties-container-properties]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-devservices-container-properties-container-properties[quarkus.kinesis.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-container-properties-container-properties]] [.property-path]##`quarkus.kinesis.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-kinesis_quarkus-kinesis-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-endpoint-override]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-endpoint-override[quarkus.kinesis.endpoint-override]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-endpoint-override]] [.property-path]##`quarkus.kinesis.endpoint-override`## +`quarkus.kinesis."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-timeout]] [.property-path]##`quarkus.kinesis.api-call-timeout`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-api-call-timeout[quarkus.kinesis.api-call-timeout]` - +`quarkus.kinesis."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-attempt-timeout]] [.property-path]##`quarkus.kinesis.api-call-attempt-timeout`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-attempt-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-api-call-attempt-timeout[quarkus.kinesis.api-call-attempt-timeout]` - +`quarkus.kinesis."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.kinesis.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-advanced-use-quarkus-scheduled-executor-service[quarkus.kinesis.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.kinesis."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_KINESIS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-aws-services-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-region]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-region[quarkus.kinesis.aws.region]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-region]] [.property-path]##`quarkus.kinesis.aws.region`## +`quarkus.kinesis."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-type]] [.property-path]##`quarkus.kinesis.aws.credentials.type`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-type[quarkus.kinesis.aws.credentials.type]` - +`quarkus.kinesis."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-async-credential-update-enabled[quarkus.kinesis.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.kinesis."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.kinesis.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.kinesis."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-access-key-id[quarkus.kinesis.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.access-key-id`## +`quarkus.kinesis."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-secret-access-key[quarkus.kinesis.aws.credentials.static-provider.secret-access-key]` - +`quarkus.kinesis."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-session-token[quarkus.kinesis.aws.credentials.static-provider.session-token]` - +`quarkus.kinesis."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-profile-name[quarkus.kinesis.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.kinesis.aws.credentials.profile-provider.profile-name`## +`quarkus.kinesis."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-async-credential-update-enabled[quarkus.kinesis.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.kinesis."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-credential-refresh-threshold[quarkus.kinesis.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.kinesis."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-output-limit[quarkus.kinesis.aws.credentials.process-provider.process-output-limit]` - +`quarkus.kinesis."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-command]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-command]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-command[quarkus.kinesis.aws.credentials.process-provider.command]` - +`quarkus.kinesis."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-name[quarkus.kinesis.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.kinesis.aws.credentials.custom-provider.name`## +`quarkus.kinesis."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-connection-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-connection-timeout[quarkus.kinesis.sync-client.connection-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-connection-timeout]] [.property-path]##`quarkus.kinesis.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-socket-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-socket-timeout[quarkus.kinesis.sync-client.socket-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-socket-timeout]] [.property-path]##`quarkus.kinesis.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-type[quarkus.kinesis.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-path[quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-type[quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-password[quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-type[quarkus.kinesis.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-path[quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-type[quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-password[quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-acquisition-timeout[quarkus.kinesis.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.kinesis.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-max-idle-time[quarkus.kinesis.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-time-to-live[quarkus.kinesis.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.kinesis.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-max-connections]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-max-connections[quarkus.kinesis.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-max-connections]] [.property-path]##`quarkus.kinesis.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-expect-continue-enabled[quarkus.kinesis.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-use-idle-connection-reaper[quarkus.kinesis.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.kinesis.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-tcp-keep-alive[quarkus.kinesis.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.kinesis.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-enabled[quarkus.kinesis.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-endpoint[quarkus.kinesis.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-username]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-username[quarkus.kinesis.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-username]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-password[quarkus.kinesis.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-password]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-domain[quarkus.kinesis.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-workstation[quarkus.kinesis.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.kinesis.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-non-proxy-hosts[quarkus.kinesis.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-connection-max-idle-time[quarkus.kinesis.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-max-concurrency[quarkus.kinesis.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.kinesis.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-enabled[quarkus.kinesis.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-endpoint[quarkus.kinesis.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-username]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-username[quarkus.kinesis.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-username]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-password[quarkus.kinesis.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-password]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kinesis_quarkus-kinesis-async-client-async-http-transport-configurations]]link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-concurrency]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-concurrency[quarkus.kinesis.async-client.max-concurrency]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-concurrency]] [.property-path]##`quarkus.kinesis.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-pending-connection-acquires[quarkus.kinesis.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.kinesis.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-read-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-read-timeout[quarkus.kinesis.async-client.read-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-read-timeout]] [.property-path]##`quarkus.kinesis.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-write-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-write-timeout[quarkus.kinesis.async-client.write-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-write-timeout]] [.property-path]##`quarkus.kinesis.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-timeout[quarkus.kinesis.async-client.connection-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-timeout]] [.property-path]##`quarkus.kinesis.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-acquisition-timeout[quarkus.kinesis.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.kinesis.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-time-to-live]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-time-to-live[quarkus.kinesis.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-time-to-live]] [.property-path]##`quarkus.kinesis.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-max-idle-time]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-max-idle-time[quarkus.kinesis.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-use-idle-connection-reaper[quarkus.kinesis.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.kinesis.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tcp-keep-alive]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tcp-keep-alive[quarkus.kinesis.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tcp-keep-alive]] [.property-path]##`quarkus.kinesis.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-protocol]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-protocol[quarkus.kinesis.async-client.protocol]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-protocol]] [.property-path]##`quarkus.kinesis.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-ssl-provider]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-ssl-provider[quarkus.kinesis.async-client.ssl-provider]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-ssl-provider]] [.property-path]##`quarkus.kinesis.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-max-streams]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-max-streams[quarkus.kinesis.async-client.http2.max-streams]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-max-streams]] [.property-path]##`quarkus.kinesis.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-initial-window-size]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-initial-window-size[quarkus.kinesis.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-initial-window-size]] [.property-path]##`quarkus.kinesis.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-health-check-ping-period[quarkus.kinesis.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.kinesis.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-enabled]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-enabled[quarkus.kinesis.async-client.proxy.enabled]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-enabled]] [.property-path]##`quarkus.kinesis.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-endpoint]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-endpoint[quarkus.kinesis.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-endpoint]] [.property-path]##`quarkus.kinesis.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-non-proxy-hosts[quarkus.kinesis.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kinesis.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-type[quarkus.kinesis.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-path[quarkus.kinesis.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-type[quarkus.kinesis.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-password[quarkus.kinesis.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-type[quarkus.kinesis.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-path[quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-type[quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-password[quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-override]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-override[quarkus.kinesis.async-client.event-loop.override]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-override]] [.property-path]##`quarkus.kinesis.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-number-of-threads[quarkus.kinesis.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.kinesis.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-thread-name-prefix[quarkus.kinesis.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.kinesis.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-kinesis_quarkus-kinesis-async-client-advanced-use-future-completion-thread-pool[quarkus.kinesis.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.kinesis.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-kinesis_quarkus-kinesis] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-kinesis_quarkus-kinesis] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis_quarkus.kinesis.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis_quarkus.kinesis.adoc new file mode 100644 index 000000000..6842697dd --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kinesis_quarkus.kinesis.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-kinesis_quarkus-kinesis +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-interceptors]] [.property-path]##`quarkus.kinesis.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-telemetry-enabled]] [.property-path]##`quarkus.kinesis.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-type]] [.property-path]##`quarkus.kinesis.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-type]] [.property-path]##`quarkus.kinesis.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-enabled]] [.property-path]##`quarkus.kinesis.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-shared]] [.property-path]##`quarkus.kinesis.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-isolated]] [.property-path]##`quarkus.kinesis.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-service-name]] [.property-path]##`quarkus.kinesis.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kinesis_quarkus-kinesis-devservices-container-properties-container-properties]] [.property-path]##`quarkus.kinesis.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-endpoint-override]] [.property-path]##`quarkus.kinesis.endpoint-override`## + +`quarkus.kinesis."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-timeout]] [.property-path]##`quarkus.kinesis.api-call-timeout`## + +`quarkus.kinesis."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-api-call-attempt-timeout]] [.property-path]##`quarkus.kinesis.api-call-attempt-timeout`## + +`quarkus.kinesis."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.kinesis.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.kinesis."client-name".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_KINESIS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-region]] [.property-path]##`quarkus.kinesis.aws.region`## + +`quarkus.kinesis."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-type]] [.property-path]##`quarkus.kinesis.aws.credentials.type`## + +`quarkus.kinesis."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.kinesis."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.kinesis."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.access-key-id`## + +`quarkus.kinesis."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.secret-access-key`## + +`quarkus.kinesis."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.kinesis.aws.credentials.static-provider.session-token`## + +`quarkus.kinesis."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.kinesis.aws.credentials.profile-provider.profile-name`## + +`quarkus.kinesis."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.kinesis."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.kinesis."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.process-output-limit`## + +`quarkus.kinesis."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-process-provider-command]] [.property-path]##`quarkus.kinesis.aws.credentials.process-provider.command`## + +`quarkus.kinesis."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.kinesis.aws.credentials.custom-provider.name`## + +`quarkus.kinesis."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-connection-timeout]] [.property-path]##`quarkus.kinesis.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-socket-timeout]] [.property-path]##`quarkus.kinesis.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.kinesis.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.kinesis.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-max-connections]] [.property-path]##`quarkus.kinesis.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.kinesis.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.kinesis.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-username]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-password]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kinesis.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.kinesis.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-username]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-sync-client-crt-proxy-password]] [.property-path]##`quarkus.kinesis.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-kinesis_section_quarkus-kinesis-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-concurrency]] [.property-path]##`quarkus.kinesis.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.kinesis.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-read-timeout]] [.property-path]##`quarkus.kinesis.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-write-timeout]] [.property-path]##`quarkus.kinesis.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-timeout]] [.property-path]##`quarkus.kinesis.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.kinesis.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-time-to-live]] [.property-path]##`quarkus.kinesis.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-connection-max-idle-time]] [.property-path]##`quarkus.kinesis.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.kinesis.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tcp-keep-alive]] [.property-path]##`quarkus.kinesis.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-protocol]] [.property-path]##`quarkus.kinesis.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-ssl-provider]] [.property-path]##`quarkus.kinesis.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-max-streams]] [.property-path]##`quarkus.kinesis.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-initial-window-size]] [.property-path]##`quarkus.kinesis.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.kinesis.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-enabled]] [.property-path]##`quarkus.kinesis.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-endpoint]] [.property-path]##`quarkus.kinesis.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kinesis.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kinesis.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-override]] [.property-path]##`quarkus.kinesis.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.kinesis.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.kinesis.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kinesis_quarkus-kinesis-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.kinesis.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KINESIS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KINESIS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-kinesis_quarkus-kinesis] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-kinesis_quarkus-kinesis] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc index 2f773f2f6..8cf903710 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-kms +:summaryTableId: quarkus-amazon-kms_quarkus-kms [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-kms_configuration]]link:#quarkus-amazon-kms_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-interceptors]] [.property-path]##`quarkus.kms.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-telemetry-enabled]]`link:#quarkus-amazon-kms_quarkus-kms-telemetry-enabled[quarkus.kms.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-telemetry-enabled]] [.property-path]##`quarkus.kms.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-sync-client-type]] [.property-path]##`quarkus.kms.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-async-client-type]] [.property-path]##`quarkus.kms.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-shared]] [.property-path]##`quarkus.kms.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-isolated]]`link:#quarkus-amazon-kms_quarkus-kms-devservices-isolated[quarkus.kms.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-isolated]] [.property-path]##`quarkus.kms.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-service-name]] [.property-path]##`quarkus.kms.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-container-properties-container-properties]] [.property-path]##`quarkus.kms.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-kms_quarkus-kms-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-kms_quarkus-kms-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-kms_section_quarkus-kms]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-kms_quarkus-kms-endpoint-override]]`link:#quarkus-amazon-kms_quarkus-kms-endpoint-override[quarkus.kms.endpoint-override]` +a| [[quarkus-amazon-kms_quarkus-kms-endpoint-override]] [.property-path]##`quarkus.kms.endpoint-override`## +`quarkus.kms."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-kms_quarkus-kms-api-call-timeout]] [.property-path]##`quarkus.kms.api-call-timeout`## -a| [[quarkus-amazon-kms_quarkus-kms-api-call-timeout]]`link:#quarkus-amazon-kms_quarkus-kms-api-call-timeout[quarkus.kms.api-call-timeout]` - +`quarkus.kms."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-kms_quarkus-kms-api-call-attempt-timeout]] [.property-path]##`quarkus.kms.api-call-attempt-timeout`## -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]` - +`quarkus.kms."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-kms_quarkus-kms-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.kms.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.kms."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-kms_section_quarkus-kms-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-kms_quarkus-kms-aws-region]]`link:#quarkus-amazon-kms_quarkus-kms-aws-region[quarkus.kms.aws.region]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-region]] [.property-path]##`quarkus.kms.aws.region`## +`quarkus.kms."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-type]] [.property-path]##`quarkus.kms.aws.credentials.type`## -a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-type]]`link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-type[quarkus.kms.aws.credentials.type]` - +`quarkus.kms."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kms.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.kms."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.kms.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.kms."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.access-key-id`## +`quarkus.kms."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.kms."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.kms."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kms_quarkus-kms-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.kms.aws.credentials.profile-provider.profile-name`## +`quarkus.kms."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.kms."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.kms."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.kms."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-command]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.command`## -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]` - +`quarkus.kms."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kms_quarkus-kms-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-kms_quarkus-kms-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.kms.aws.credentials.custom-provider.name`## +`quarkus.kms."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kms_quarkus-kms-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-kms_quarkus-kms-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-connection-timeout]] [.property-path]##`quarkus.kms.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-kms_quarkus-kms-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-kms_quarkus-kms-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-max-connections]] [.property-path]##`quarkus.kms.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.kms.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.kms.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-username]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-password]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-kms_quarkus-kms-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-connection-max-idle-time[quarkus.kms.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.kms.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-max-concurrency[quarkus.kms.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.kms.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-enabled[quarkus.kms.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-endpoint[quarkus.kms.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-username]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-username[quarkus.kms.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-username]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-password]]`link:#quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-password[quarkus.kms.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-password]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-kms_quarkus-kms-async-client-async-http-transport-configurations]]link:#quarkus-amazon-kms_quarkus-kms-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-kms_section_quarkus-kms-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-max-concurrency]] [.property-path]##`quarkus.kms.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.kms.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-read-timeout]] [.property-path]##`quarkus.kms.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-write-timeout]] [.property-path]##`quarkus.kms.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-timeout]] [.property-path]##`quarkus.kms.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-max-idle-time]] [.property-path]##`quarkus.kms.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.kms.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tcp-keep-alive]] [.property-path]##`quarkus.kms.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-kms_quarkus-kms-async-client-protocol]]`link:#quarkus-amazon-kms_quarkus-kms-async-client-protocol[quarkus.kms.async-client.protocol]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-protocol]] [.property-path]##`quarkus.kms.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-ssl-provider]] [.property-path]##`quarkus.kms.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-max-streams]] [.property-path]##`quarkus.kms.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-initial-window-size]] [.property-path]##`quarkus.kms.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.kms.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-enabled]] [.property-path]##`quarkus.kms.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-endpoint]] [.property-path]##`quarkus.kms.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kms.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-override]] [.property-path]##`quarkus.kms.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.kms.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.kms.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-kms_quarkus-kms-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.kms.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-kms_quarkus-kms] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-kms_quarkus-kms] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-kms_quarkus.kms.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms_quarkus.kms.adoc new file mode 100644 index 000000000..8cf903710 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-kms_quarkus.kms.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-kms_quarkus-kms +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-telemetry-enabled]] [.property-path]##`quarkus.kms.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-sync-client-type]] [.property-path]##`quarkus.kms.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-async-client-type]] [.property-path]##`quarkus.kms.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-isolated]] [.property-path]##`quarkus.kms.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-kms_quarkus-kms-devservices-container-properties-container-properties]] [.property-path]##`quarkus.kms.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-kms_section_quarkus-kms]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-endpoint-override]] [.property-path]##`quarkus.kms.endpoint-override`## + +`quarkus.kms."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kms_quarkus-kms-api-call-timeout]] [.property-path]##`quarkus.kms.api-call-timeout`## + +`quarkus.kms."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kms_quarkus-kms-api-call-attempt-timeout]] [.property-path]##`quarkus.kms.api-call-attempt-timeout`## + +`quarkus.kms."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kms_quarkus-kms-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.kms.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.kms."client-name".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_section_quarkus-kms-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-region]] [.property-path]##`quarkus.kms.aws.region`## + +`quarkus.kms."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-type]] [.property-path]##`quarkus.kms.aws.credentials.type`## + +`quarkus.kms."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kms.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.kms."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.kms.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.kms."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.access-key-id`## + +`quarkus.kms."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.secret-access-key`## + +`quarkus.kms."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.kms.aws.credentials.static-provider.session-token`## + +`quarkus.kms."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.kms.aws.credentials.profile-provider.profile-name`## + +`quarkus.kms."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.kms."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.kms."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.process-output-limit`## + +`quarkus.kms."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-process-provider-command]] [.property-path]##`quarkus.kms.aws.credentials.process-provider.command`## + +`quarkus.kms."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-kms_section_quarkus-kms-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.kms.aws.credentials.custom-provider.name`## + +`quarkus.kms."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-connection-timeout]] [.property-path]##`quarkus.kms.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-max-connections]] [.property-path]##`quarkus.kms.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.kms.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.kms.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-username]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-password]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kms.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-kms_section_quarkus-kms-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.kms.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.kms.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-username]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-sync-client-crt-proxy-password]] [.property-path]##`quarkus.kms.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-kms_section_quarkus-kms-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-max-concurrency]] [.property-path]##`quarkus.kms.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.kms.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-read-timeout]] [.property-path]##`quarkus.kms.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-write-timeout]] [.property-path]##`quarkus.kms.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-timeout]] [.property-path]##`quarkus.kms.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.kms.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tcp-keep-alive]] [.property-path]##`quarkus.kms.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-protocol]] [.property-path]##`quarkus.kms.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-ssl-provider]] [.property-path]##`quarkus.kms.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-max-streams]] [.property-path]##`quarkus.kms.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-initial-window-size]] [.property-path]##`quarkus.kms.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-enabled]] [.property-path]##`quarkus.kms.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-endpoint]] [.property-path]##`quarkus.kms.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.kms.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.kms.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-override]] [.property-path]##`quarkus.kms.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.kms.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-kms_quarkus-kms-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_KMS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_KMS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-kms_quarkus-kms] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-kms_quarkus-kms] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda.adoc index 5c70809fc..fa1713986 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-lambda +:summaryTableId: quarkus-amazon-lambda_quarkus-lambda [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-lambda_configuration]]link:#quarkus-amazon-lambda_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-interceptors]]`link:#quarkus-amazon-lambda_quarkus-lambda-interceptors[quarkus.lambda.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-interceptors]] [.property-path]##`quarkus.lambda.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-telemetry-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-telemetry-enabled[quarkus.lambda.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-telemetry-enabled]] [.property-path]##`quarkus.lambda.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-sync-client-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-type[quarkus.lambda.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-sync-client-type]] [.property-path]##`quarkus.lambda.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-async-client-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-type[quarkus.lambda.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-async-client-type]] [.property-path]##`quarkus.lambda.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-devservices-enabled[quarkus.lambda.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-enabled]] [.property-path]##`quarkus.lambda.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-shared]]`link:#quarkus-amazon-lambda_quarkus-lambda-devservices-shared[quarkus.lambda.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-shared]] [.property-path]##`quarkus.lambda.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-isolated]]`link:#quarkus-amazon-lambda_quarkus-lambda-devservices-isolated[quarkus.lambda.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-isolated]] [.property-path]##`quarkus.lambda.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-service-name]]`link:#quarkus-amazon-lambda_quarkus-lambda-devservices-service-name[quarkus.lambda.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-service-name]] [.property-path]##`quarkus.lambda.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-container-properties-container-properties]]`link:#quarkus-amazon-lambda_quarkus-lambda-devservices-container-properties-container-properties[quarkus.lambda.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-container-properties-container-properties]] [.property-path]##`quarkus.lambda.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-lambda_quarkus-lambda-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-endpoint-override]]`link:#quarkus-amazon-lambda_quarkus-lambda-endpoint-override[quarkus.lambda.endpoint-override]` +a| [[quarkus-amazon-lambda_quarkus-lambda-endpoint-override]] [.property-path]##`quarkus.lambda.endpoint-override`## +`quarkus.lambda."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-timeout]] [.property-path]##`quarkus.lambda.api-call-timeout`## -a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-api-call-timeout[quarkus.lambda.api-call-timeout]` - +`quarkus.lambda."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-attempt-timeout]] [.property-path]##`quarkus.lambda.api-call-attempt-timeout`## -a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-attempt-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-api-call-attempt-timeout[quarkus.lambda.api-call-attempt-timeout]` - +`quarkus.lambda."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-lambda_quarkus-lambda-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.lambda.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-lambda_quarkus-lambda-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-lambda_quarkus-lambda-advanced-use-quarkus-scheduled-executor-service[quarkus.lambda.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.lambda."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_LAMBDA_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-aws-services-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-region]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-region[quarkus.lambda.aws.region]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-region]] [.property-path]##`quarkus.lambda.aws.region`## +`quarkus.lambda."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-type]] [.property-path]##`quarkus.lambda.aws.credentials.type`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-type[quarkus.lambda.aws.credentials.type]` - +`quarkus.lambda."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-async-credential-update-enabled[quarkus.lambda.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.lambda."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.lambda.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.lambda."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-access-key-id[quarkus.lambda.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.access-key-id`## +`quarkus.lambda."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-secret-access-key[quarkus.lambda.aws.credentials.static-provider.secret-access-key]` - +`quarkus.lambda."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-session-token[quarkus.lambda.aws.credentials.static-provider.session-token]` - +`quarkus.lambda."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-profile-name[quarkus.lambda.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.lambda.aws.credentials.profile-provider.profile-name`## +`quarkus.lambda."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-async-credential-update-enabled[quarkus.lambda.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.lambda."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-credential-refresh-threshold[quarkus.lambda.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.lambda."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-output-limit[quarkus.lambda.aws.credentials.process-provider.process-output-limit]` - +`quarkus.lambda."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-command]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-command]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-command[quarkus.lambda.aws.credentials.process-provider.command]` - +`quarkus.lambda."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-name[quarkus.lambda.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.lambda.aws.credentials.custom-provider.name`## +`quarkus.lambda."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-lambda_quarkus-lambda-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-connection-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-connection-timeout[quarkus.lambda.sync-client.connection-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-connection-timeout]] [.property-path]##`quarkus.lambda.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-socket-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-socket-timeout[quarkus.lambda.sync-client.socket-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-socket-timeout]] [.property-path]##`quarkus.lambda.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-type[quarkus.lambda.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-path[quarkus.lambda.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-type[quarkus.lambda.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-password[quarkus.lambda.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-type[quarkus.lambda.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-path[quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-type[quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-password[quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-acquisition-timeout[quarkus.lambda.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.lambda.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-max-idle-time[quarkus.lambda.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.lambda.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-time-to-live[quarkus.lambda.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.lambda.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-max-connections]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-max-connections[quarkus.lambda.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-max-connections]] [.property-path]##`quarkus.lambda.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-expect-continue-enabled[quarkus.lambda.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-use-idle-connection-reaper[quarkus.lambda.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.lambda.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-tcp-keep-alive[quarkus.lambda.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.lambda.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-enabled[quarkus.lambda.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-endpoint[quarkus.lambda.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-username]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-username[quarkus.lambda.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-username]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-password[quarkus.lambda.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-password]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-domain[quarkus.lambda.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-workstation[quarkus.lambda.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.lambda.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-non-proxy-hosts[quarkus.lambda.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-connection-max-idle-time[quarkus.lambda.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.lambda.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-max-concurrency[quarkus.lambda.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.lambda.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-enabled[quarkus.lambda.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-endpoint[quarkus.lambda.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-username]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-username[quarkus.lambda.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-username]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-password[quarkus.lambda.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-password]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-lambda_quarkus-lambda-async-client-async-http-transport-configurations]]link:#quarkus-amazon-lambda_quarkus-lambda-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-lambda_section_quarkus-lambda-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-concurrency]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-max-concurrency[quarkus.lambda.async-client.max-concurrency]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-concurrency]] [.property-path]##`quarkus.lambda.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-max-pending-connection-acquires[quarkus.lambda.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.lambda.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-read-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-read-timeout[quarkus.lambda.async-client.read-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-read-timeout]] [.property-path]##`quarkus.lambda.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-write-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-write-timeout[quarkus.lambda.async-client.write-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-write-timeout]] [.property-path]##`quarkus.lambda.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-connection-timeout[quarkus.lambda.async-client.connection-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-timeout]] [.property-path]##`quarkus.lambda.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-connection-acquisition-timeout[quarkus.lambda.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.lambda.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-time-to-live]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-connection-time-to-live[quarkus.lambda.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-time-to-live]] [.property-path]##`quarkus.lambda.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-max-idle-time]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-connection-max-idle-time[quarkus.lambda.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-max-idle-time]] [.property-path]##`quarkus.lambda.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-use-idle-connection-reaper[quarkus.lambda.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.lambda.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tcp-keep-alive]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tcp-keep-alive[quarkus.lambda.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tcp-keep-alive]] [.property-path]##`quarkus.lambda.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-protocol]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-protocol[quarkus.lambda.async-client.protocol]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-protocol]] [.property-path]##`quarkus.lambda.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-ssl-provider]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-ssl-provider[quarkus.lambda.async-client.ssl-provider]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-ssl-provider]] [.property-path]##`quarkus.lambda.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-max-streams]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-http2-max-streams[quarkus.lambda.async-client.http2.max-streams]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-max-streams]] [.property-path]##`quarkus.lambda.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-initial-window-size]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-http2-initial-window-size[quarkus.lambda.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-initial-window-size]] [.property-path]##`quarkus.lambda.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-http2-health-check-ping-period[quarkus.lambda.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.lambda.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-enabled]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-enabled[quarkus.lambda.async-client.proxy.enabled]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-enabled]] [.property-path]##`quarkus.lambda.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-endpoint]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-endpoint[quarkus.lambda.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-endpoint]] [.property-path]##`quarkus.lambda.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-non-proxy-hosts[quarkus.lambda.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.lambda.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-type[quarkus.lambda.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-path[quarkus.lambda.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-type[quarkus.lambda.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-password[quarkus.lambda.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-type[quarkus.lambda.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-path[quarkus.lambda.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-type[quarkus.lambda.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-password[quarkus.lambda.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-override]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-override[quarkus.lambda.async-client.event-loop.override]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-override]] [.property-path]##`quarkus.lambda.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-number-of-threads[quarkus.lambda.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.lambda.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-thread-name-prefix[quarkus.lambda.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.lambda.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-lambda_quarkus-lambda-async-client-advanced-use-future-completion-thread-pool[quarkus.lambda.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.lambda.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-lambda_quarkus-lambda] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-lambda_quarkus-lambda] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda_quarkus.lambda.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda_quarkus.lambda.adoc new file mode 100644 index 000000000..fa1713986 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-lambda_quarkus.lambda.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-lambda_quarkus-lambda +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-interceptors]] [.property-path]##`quarkus.lambda.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-telemetry-enabled]] [.property-path]##`quarkus.lambda.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-sync-client-type]] [.property-path]##`quarkus.lambda.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-async-client-type]] [.property-path]##`quarkus.lambda.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-enabled]] [.property-path]##`quarkus.lambda.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-shared]] [.property-path]##`quarkus.lambda.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-isolated]] [.property-path]##`quarkus.lambda.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-service-name]] [.property-path]##`quarkus.lambda.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-lambda_quarkus-lambda-devservices-container-properties-container-properties]] [.property-path]##`quarkus.lambda.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-lambda_section_quarkus-lambda]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-endpoint-override]] [.property-path]##`quarkus.lambda.endpoint-override`## + +`quarkus.lambda."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-timeout]] [.property-path]##`quarkus.lambda.api-call-timeout`## + +`quarkus.lambda."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-api-call-attempt-timeout]] [.property-path]##`quarkus.lambda.api-call-attempt-timeout`## + +`quarkus.lambda."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.lambda.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.lambda."client-name".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_LAMBDA_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-region]] [.property-path]##`quarkus.lambda.aws.region`## + +`quarkus.lambda."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-type]] [.property-path]##`quarkus.lambda.aws.credentials.type`## + +`quarkus.lambda."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.lambda."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.lambda."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.access-key-id`## + +`quarkus.lambda."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.secret-access-key`## + +`quarkus.lambda."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.lambda.aws.credentials.static-provider.session-token`## + +`quarkus.lambda."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.lambda.aws.credentials.profile-provider.profile-name`## + +`quarkus.lambda."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.lambda."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.lambda."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.process-output-limit`## + +`quarkus.lambda."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-process-provider-command]] [.property-path]##`quarkus.lambda.aws.credentials.process-provider.command`## + +`quarkus.lambda."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.lambda.aws.credentials.custom-provider.name`## + +`quarkus.lambda."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-connection-timeout]] [.property-path]##`quarkus.lambda.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-socket-timeout]] [.property-path]##`quarkus.lambda.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.lambda.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.lambda.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.lambda.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-max-connections]] [.property-path]##`quarkus.lambda.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.lambda.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.lambda.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-username]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-password]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.lambda.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.lambda.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.lambda.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-username]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-sync-client-crt-proxy-password]] [.property-path]##`quarkus.lambda.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-lambda_section_quarkus-lambda-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-concurrency]] [.property-path]##`quarkus.lambda.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.lambda.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-read-timeout]] [.property-path]##`quarkus.lambda.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-write-timeout]] [.property-path]##`quarkus.lambda.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-timeout]] [.property-path]##`quarkus.lambda.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.lambda.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-time-to-live]] [.property-path]##`quarkus.lambda.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-connection-max-idle-time]] [.property-path]##`quarkus.lambda.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.lambda.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tcp-keep-alive]] [.property-path]##`quarkus.lambda.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-protocol]] [.property-path]##`quarkus.lambda.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-ssl-provider]] [.property-path]##`quarkus.lambda.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-max-streams]] [.property-path]##`quarkus.lambda.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-initial-window-size]] [.property-path]##`quarkus.lambda.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.lambda.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-enabled]] [.property-path]##`quarkus.lambda.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-endpoint]] [.property-path]##`quarkus.lambda.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.lambda.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.lambda.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-override]] [.property-path]##`quarkus.lambda.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.lambda.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.lambda.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-lambda_quarkus-lambda-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.lambda.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_LAMBDA_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_LAMBDA_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-lambda_quarkus-lambda] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-lambda_quarkus-lambda] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc index f6681a7c6..000b7be91 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-s3 +:summaryTableId: quarkus-amazon-s3_quarkus-s3 [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-s3_configuration]]link:#quarkus-amazon-s3_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-interceptors]] [.property-path]##`quarkus.s3.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-telemetry-enabled]]`link:#quarkus-amazon-s3_quarkus-s3-telemetry-enabled[quarkus.s3.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-telemetry-enabled]] [.property-path]##`quarkus.s3.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-sync-client-type]] [.property-path]##`quarkus.s3.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-async-client-type]] [.property-path]##`quarkus.s3.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-shared]] [.property-path]##`quarkus.s3.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-isolated]]`link:#quarkus-amazon-s3_quarkus-s3-devservices-isolated[quarkus.s3.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-isolated]] [.property-path]##`quarkus.s3.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-service-name]] [.property-path]##`quarkus.s3.devservices.service-name`## [.description] -- @@ -146,35 +141,52 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-container-properties-container-properties]] [.property-path]##`quarkus.s3.devservices.container-properties."container-properties"`## -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] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-buckets]] [.property-path]##`quarkus.s3.devservices.buckets`## [.description] -- The buckets to create on startup. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_BUCKETS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DEVSERVICES_BUCKETS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string |`default` - -a| [[quarkus-amazon-s3_quarkus-s3-accelerate-mode]]`link:#quarkus-amazon-s3_quarkus-s3-accelerate-mode[quarkus.s3.accelerate-mode]` - +a| [[quarkus-amazon-s3_quarkus-s3-accelerate-mode]] [.property-path]##`quarkus.s3.accelerate-mode`## [.description] -- @@ -182,103 +194,103 @@ Enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ACCELERATE_MODE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ACCELERATE_MODE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-s3_quarkus-s3-checksum-validation]]`link:#quarkus-amazon-s3_quarkus-s3-checksum-validation[quarkus.s3.checksum-validation]` - +a| [[quarkus-amazon-s3_quarkus-s3-checksum-validation]] [.property-path]##`quarkus.s3.checksum-validation`## [.description] -- Enable doing a validation of the checksum of an object stored in S3. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CHECKSUM_VALIDATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CHECKSUM_VALIDATION+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-s3_quarkus-s3-chunked-encoding]]`link:#quarkus-amazon-s3_quarkus-s3-chunked-encoding[quarkus.s3.chunked-encoding]` - +a| [[quarkus-amazon-s3_quarkus-s3-chunked-encoding]] [.property-path]##`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`. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CHUNKED_ENCODING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CHUNKED_ENCODING+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-s3_quarkus-s3-dualstack]]`link:#quarkus-amazon-s3_quarkus-s3-dualstack[quarkus.s3.dualstack]` - +a| [[quarkus-amazon-s3_quarkus-s3-dualstack]] [.property-path]##`quarkus.s3.dualstack`## [.description] -- Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DUALSTACK+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_DUALSTACK+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-s3_quarkus-s3-path-style-access]]`link:#quarkus-amazon-s3_quarkus-s3-path-style-access[quarkus.s3.path-style-access]` - +a| [[quarkus-amazon-s3_quarkus-s3-path-style-access]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_PATH_STYLE_ACCESS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_PATH_STYLE_ACCESS+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-use-arn-region-enabled]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_USE_ARN_REGION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_USE_ARN_REGION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-s3_quarkus-s3-profile-name]]`link:#quarkus-amazon-s3_quarkus-s3-profile-name[quarkus.s3.profile-name]` - +a| [[quarkus-amazon-s3_quarkus-s3-profile-name]] [.property-path]##`quarkus.s3.profile-name`## [.description] -- @@ -286,41 +298,24 @@ Define the profile name that should be consulted to determine the default value If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string -| - - -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."container-properties"]` - - -[.description] -- -Generic properties that are pass for additional container configuration. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +|string | - -h|[[quarkus-amazon-s3_quarkus-s3-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-s3_quarkus-s3-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-s3_section_quarkus-s3]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-s3_quarkus-s3-endpoint-override]]`link:#quarkus-amazon-s3_quarkus-s3-endpoint-override[quarkus.s3.endpoint-override]` +a| [[quarkus-amazon-s3_quarkus-s3-endpoint-override]] [.property-path]##`quarkus.s3.endpoint-override`## +`quarkus.s3."client-name".endpoint-override` [.description] -- @@ -328,19 +323,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-s3_quarkus-s3-api-call-timeout]] [.property-path]##`quarkus.s3.api-call-timeout`## -a| [[quarkus-amazon-s3_quarkus-s3-api-call-timeout]]`link:#quarkus-amazon-s3_quarkus-s3-api-call-timeout[quarkus.s3.api-call-timeout]` - +`quarkus.s3."client-name".api-call-timeout` [.description] -- @@ -350,19 +346,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-s3_quarkus-s3-api-call-attempt-timeout]] [.property-path]##`quarkus.s3.api-call-attempt-timeout`## -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]` - +`quarkus.s3."client-name".api-call-attempt-timeout` [.description] -- @@ -370,19 +367,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-s3_quarkus-s3-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.s3.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.s3."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -390,23 +388,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-s3_section_quarkus-s3-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-s3_quarkus-s3-aws-region]]`link:#quarkus-amazon-s3_quarkus-s3-aws-region[quarkus.s3.aws.region]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-region]] [.property-path]##`quarkus.s3.aws.region`## +`quarkus.s3."client-name".aws.region` [.description] -- @@ -423,18 +423,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-type]] [.property-path]##`quarkus.s3.aws.credentials.type`## -a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-type]]`link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-type[quarkus.s3.aws.credentials.type]` - +`quarkus.s3."client-name".aws.credentials.type` [.description] -- @@ -463,24 +465,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.s3.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.s3."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -488,18 +490,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.s3.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.s3."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -507,79 +511,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.access-key-id`## +`quarkus.s3."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.s3."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.s3."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-s3_quarkus-s3-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.s3.aws.credentials.profile-provider.profile-name`## +`quarkus.s3."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -587,23 +599,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.s3."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -611,18 +625,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.s3."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -630,116 +646,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.s3."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-command]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.command`## -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]` - +`quarkus.s3."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-s3_quarkus-s3-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-s3_quarkus-s3-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.s3.aws.credentials.custom-provider.name`## +`quarkus.s3."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-s3_quarkus-s3-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-s3_quarkus-s3-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-connection-timeout]] [.property-path]##`quarkus.s3.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -753,36 +773,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -790,35 +809,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -832,36 +851,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -869,94 +887,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-s3_quarkus-s3-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-s3_quarkus-s3-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-max-connections]] [.property-path]##`quarkus.s3.sync-client.apache.max-connections`## [.description] -- @@ -964,35 +978,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.s3.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -1000,52 +1014,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.s3.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.endpoint`## [.description] -- @@ -1053,178 +1067,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-username]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-password]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-s3_quarkus-s3-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-connection-max-idle-time[quarkus.s3.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.s3.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-max-concurrency[quarkus.s3.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.s3.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-enabled[quarkus.s3.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-endpoint[quarkus.s3.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1232,58 +1244,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-username]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-username[quarkus.s3.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-username]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-password]]`link:#quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-password[quarkus.s3.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-password]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-s3_quarkus-s3-async-client-async-http-transport-configurations]]link:#quarkus-amazon-s3_quarkus-s3-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-s3_section_quarkus-s3-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-max-concurrency]] [.property-path]##`quarkus.s3.async-client.max-concurrency`## [.description] -- @@ -1291,18 +1303,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.s3.async-client.max-pending-connection-acquires`## [.description] -- @@ -1310,18 +1322,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-read-timeout]] [.property-path]##`quarkus.s3.async-client.read-timeout`## [.description] -- @@ -1329,19 +1341,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-write-timeout]] [.property-path]##`quarkus.s3.async-client.write-timeout`## [.description] -- @@ -1349,73 +1360,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-timeout]] [.property-path]##`quarkus.s3.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-max-idle-time]] [.property-path]##`quarkus.s3.async-client.connection-max-idle-time`## [.description] -- @@ -1423,19 +1430,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.s3.async-client.use-idle-connection-reaper`## [.description] -- @@ -1443,53 +1449,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tcp-keep-alive]] [.property-path]##`quarkus.s3.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-s3_quarkus-s3-async-client-protocol]]`link:#quarkus-amazon-s3_quarkus-s3-async-client-protocol[quarkus.s3.async-client.protocol]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-protocol]] [.property-path]##`quarkus.s3.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-ssl-provider]] [.property-path]##`quarkus.s3.async-client.ssl-provider`## [.description] -- @@ -1497,19 +1502,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-max-streams]] [.property-path]##`quarkus.s3.async-client.http2.max-streams`## [.description] -- @@ -1517,18 +1521,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-initial-window-size]] [.property-path]##`quarkus.s3.async-client.http2.initial-window-size`## [.description] -- @@ -1536,18 +1540,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.s3.async-client.http2.health-check-ping-period`## [.description] -- @@ -1555,36 +1559,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-enabled]] [.property-path]##`quarkus.s3.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-endpoint]] [.property-path]##`quarkus.s3.async-client.proxy.endpoint`## [.description] -- @@ -1592,36 +1595,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.s3.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1635,36 +1637,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1672,35 +1673,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1714,36 +1715,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1751,52 +1751,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-override]] [.property-path]##`quarkus.s3.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.s3.async-client.event-loop.number-of-threads`## [.description] -- @@ -1804,18 +1804,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.s3.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1825,18 +1825,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-s3_quarkus-s3-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.s3.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1844,109 +1844,113 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-s3_quarkus-s3-crt-client-aws-crt-based-s3-client-configurations]]link:#quarkus-amazon-s3_quarkus-s3-crt-client-aws-crt-based-s3-client-configurations[AWS CRT-based S3 client configurations] - +h|[[quarkus-amazon-s3_section_quarkus-s3-crt-client]] [.section-name.section-level0]##AWS CRT-based S3 client configurations## h|Type h|Default -a| [[quarkus-amazon-s3_quarkus-s3-crt-client-initial-read-buffer-size-in-bytes]]`link:#quarkus-amazon-s3_quarkus-s3-crt-client-initial-read-buffer-size-in-bytes[quarkus.s3.crt-client.initial-read-buffer-size-in-bytes]` - +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-initial-read-buffer-size-in-bytes]] [.property-path]##`quarkus.s3.crt-client.initial-read-buffer-size-in-bytes`## [.description] -- Configure the starting buffer size the client will use to buffer the parts downloaded from S3. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_INITIAL_READ_BUFFER_SIZE_IN_BYTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CRT_CLIENT_INITIAL_READ_BUFFER_SIZE_IN_BYTES+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`Equal to the resolved part size * 10` - -a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-concurrency]]`link:#quarkus-amazon-s3_quarkus-s3-crt-client-max-concurrency[quarkus.s3.crt-client.max-concurrency]` - +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-concurrency]] [.property-path]##`quarkus.s3.crt-client.max-concurrency`## [.description] -- Specifies the maximum number of S3 connections that should be established during a transfer. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-s3_quarkus-s3-crt-client-minimum-part-size-in-bytes]]`link:#quarkus-amazon-s3_quarkus-s3-crt-client-minimum-part-size-in-bytes[quarkus.s3.crt-client.minimum-part-size-in-bytes]` - +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-minimum-part-size-in-bytes]] [.property-path]##`quarkus.s3.crt-client.minimum-part-size-in-bytes`## [.description] -- Sets the minimum part size for transfer parts. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MINIMUM_PART_SIZE_IN_BYTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MINIMUM_PART_SIZE_IN_BYTES+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`8MB` - -a| [[quarkus-amazon-s3_quarkus-s3-crt-client-target-throughput-in-gbps]]`link:#quarkus-amazon-s3_quarkus-s3-crt-client-target-throughput-in-gbps[quarkus.s3.crt-client.target-throughput-in-gbps]` - +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-target-throughput-in-gbps]] [.property-path]##`quarkus.s3.crt-client.target-throughput-in-gbps`## [.description] -- The target throughput for transfer requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_TARGET_THROUGHPUT_IN_GBPS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CRT_CLIENT_TARGET_THROUGHPUT_IN_GBPS+++` endif::add-copy-button-to-env-var[] ---|double +-- +|double |`10` - -a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-native-memory-limit-in-bytes]]`link:#quarkus-amazon-s3_quarkus-s3-crt-client-max-native-memory-limit-in-bytes[quarkus.s3.crt-client.max-native-memory-limit-in-bytes]` - +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-native-memory-limit-in-bytes]] [.property-path]##`quarkus.s3.crt-client.max-native-memory-limit-in-bytes`## [.description] -- The amount of native memory that CRT is allowed to use when making requests to S3. Only specify the memory limit explicitly when necessary. Refer to the AWS SDK documentation for further details. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MAX_NATIVE_MEMORY_LIMIT_IN_BYTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MAX_NATIVE_MEMORY_LIMIT_IN_BYTES+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`Based on a number of parameters such as target throughput` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-s3_quarkus-s3] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1963,11 +1967,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-s3_quarkus-s3] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-s3_quarkus.s3.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3_quarkus.s3.adoc new file mode 100644 index 000000000..000b7be91 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-s3_quarkus.s3.adoc @@ -0,0 +1,1981 @@ +:summaryTableId: quarkus-amazon-s3_quarkus-s3 +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-telemetry-enabled]] [.property-path]##`quarkus.s3.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-sync-client-type]] [.property-path]##`quarkus.s3.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-async-client-type]] [.property-path]##`quarkus.s3.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-isolated]] [.property-path]##`quarkus.s3.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-container-properties-container-properties]] [.property-path]##`quarkus.s3.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-s3_quarkus-s3-devservices-buckets]] [.property-path]##`quarkus.s3.devservices.buckets`## + +[.description] +-- +The buckets to create on startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DEVSERVICES_BUCKETS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DEVSERVICES_BUCKETS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +|`default` + +a| [[quarkus-amazon-s3_quarkus-s3-accelerate-mode]] [.property-path]##`quarkus.s3.accelerate-mode`## + +[.description] +-- +Enable using the accelerate endpoint when accessing S3. + +Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ACCELERATE_MODE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ACCELERATE_MODE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-checksum-validation]] [.property-path]##`quarkus.s3.checksum-validation`## + +[.description] +-- +Enable doing a validation of the checksum of an object stored in S3. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CHECKSUM_VALIDATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CHECKSUM_VALIDATION+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-s3_quarkus-s3-chunked-encoding]] [.property-path]##`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`. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CHUNKED_ENCODING+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CHUNKED_ENCODING+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-s3_quarkus-s3-dualstack]] [.property-path]##`quarkus.s3.dualstack`## + +[.description] +-- +Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_DUALSTACK+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_DUALSTACK+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-path-style-access]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_PATH_STYLE_ACCESS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_PATH_STYLE_ACCESS+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-use-arn-region-enabled]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_USE_ARN_REGION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_USE_ARN_REGION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-profile-name]] [.property-path]##`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'. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-s3_section_quarkus-s3]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-endpoint-override]] [.property-path]##`quarkus.s3.endpoint-override`## + +`quarkus.s3."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-s3_quarkus-s3-api-call-timeout]] [.property-path]##`quarkus.s3.api-call-timeout`## + +`quarkus.s3."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-s3_quarkus-s3-api-call-attempt-timeout]] [.property-path]##`quarkus.s3.api-call-attempt-timeout`## + +`quarkus.s3."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-s3_quarkus-s3-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.s3.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.s3."client-name".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_section_quarkus-s3-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-region]] [.property-path]##`quarkus.s3.aws.region`## + +`quarkus.s3."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-type]] [.property-path]##`quarkus.s3.aws.credentials.type`## + +`quarkus.s3."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.s3.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.s3."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.s3.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.s3."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.access-key-id`## + +`quarkus.s3."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.secret-access-key`## + +`quarkus.s3."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.s3.aws.credentials.static-provider.session-token`## + +`quarkus.s3."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.s3.aws.credentials.profile-provider.profile-name`## + +`quarkus.s3."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.s3."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.s3."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.process-output-limit`## + +`quarkus.s3."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-process-provider-command]] [.property-path]##`quarkus.s3.aws.credentials.process-provider.command`## + +`quarkus.s3."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-s3_section_quarkus-s3-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.s3.aws.credentials.custom-provider.name`## + +`quarkus.s3."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-connection-timeout]] [.property-path]##`quarkus.s3.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-max-connections]] [.property-path]##`quarkus.s3.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.s3.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.s3.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-username]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-password]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.s3.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-s3_section_quarkus-s3-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.s3.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.s3.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-username]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-sync-client-crt-proxy-password]] [.property-path]##`quarkus.s3.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-s3_section_quarkus-s3-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-max-concurrency]] [.property-path]##`quarkus.s3.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.s3.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-read-timeout]] [.property-path]##`quarkus.s3.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-write-timeout]] [.property-path]##`quarkus.s3.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-timeout]] [.property-path]##`quarkus.s3.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.s3.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tcp-keep-alive]] [.property-path]##`quarkus.s3.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-protocol]] [.property-path]##`quarkus.s3.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-ssl-provider]] [.property-path]##`quarkus.s3.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-max-streams]] [.property-path]##`quarkus.s3.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-initial-window-size]] [.property-path]##`quarkus.s3.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-enabled]] [.property-path]##`quarkus.s3.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-endpoint]] [.property-path]##`quarkus.s3.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.s3.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.s3.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-override]] [.property-path]##`quarkus.s3.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.s3.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-s3_quarkus-s3-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-s3_section_quarkus-s3-crt-client]] [.section-name.section-level0]##AWS CRT-based S3 client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-initial-read-buffer-size-in-bytes]] [.property-path]##`quarkus.s3.crt-client.initial-read-buffer-size-in-bytes`## + +[.description] +-- +Configure the starting buffer size the client will use to buffer the parts downloaded from S3. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_INITIAL_READ_BUFFER_SIZE_IN_BYTES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CRT_CLIENT_INITIAL_READ_BUFFER_SIZE_IN_BYTES+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`Equal to the resolved part size * 10` + +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-concurrency]] [.property-path]##`quarkus.s3.crt-client.max-concurrency`## + +[.description] +-- +Specifies the maximum number of S3 connections that should be established during a transfer. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-minimum-part-size-in-bytes]] [.property-path]##`quarkus.s3.crt-client.minimum-part-size-in-bytes`## + +[.description] +-- +Sets the minimum part size for transfer parts. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MINIMUM_PART_SIZE_IN_BYTES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MINIMUM_PART_SIZE_IN_BYTES+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`8MB` + +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-target-throughput-in-gbps]] [.property-path]##`quarkus.s3.crt-client.target-throughput-in-gbps`## + +[.description] +-- +The target throughput for transfer requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_TARGET_THROUGHPUT_IN_GBPS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CRT_CLIENT_TARGET_THROUGHPUT_IN_GBPS+++` +endif::add-copy-button-to-env-var[] +-- +|double +|`10` + +a| [[quarkus-amazon-s3_quarkus-s3-crt-client-max-native-memory-limit-in-bytes]] [.property-path]##`quarkus.s3.crt-client.max-native-memory-limit-in-bytes`## + +[.description] +-- +The amount of native memory that CRT is allowed to use when making requests to S3. Only specify the memory limit explicitly when necessary. Refer to the AWS SDK documentation for further details. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_S3_CRT_CLIENT_MAX_NATIVE_MEMORY_LIMIT_IN_BYTES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_S3_CRT_CLIENT_MAX_NATIVE_MEMORY_LIMIT_IN_BYTES+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`Based on a number of parameters such as target throughput` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-s3_quarkus-s3] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-s3_quarkus-s3] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc index f308650dc..688e7a849 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-secretsmanager +:summaryTableId: quarkus-amazon-secretsmanager_quarkus-secretsmanager [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-secretsmanager_configuration]]link:#quarkus-amazon-secretsmanager_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-interceptors]] [.property-path]##`quarkus.secretsmanager.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-telemetry-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-telemetry-enabled[quarkus.secretsmanager.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-telemetry-enabled]] [.property-path]##`quarkus.secretsmanager.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-type]] [.property-path]##`quarkus.secretsmanager.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-type]] [.property-path]##`quarkus.secretsmanager.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-shared]] [.property-path]##`quarkus.secretsmanager.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-isolated]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-isolated[quarkus.secretsmanager.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-isolated]] [.property-path]##`quarkus.secretsmanager.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-service-name]] [.property-path]##`quarkus.secretsmanager.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-container-properties-container-properties]] [.property-path]##`quarkus.secretsmanager.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-endpoint-override]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-endpoint-override[quarkus.secretsmanager.endpoint-override]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-endpoint-override]] [.property-path]##`quarkus.secretsmanager.endpoint-override`## +`quarkus.secretsmanager."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-timeout]] [.property-path]##`quarkus.secretsmanager.api-call-timeout`## -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-timeout]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-timeout[quarkus.secretsmanager.api-call-timeout]` - +`quarkus.secretsmanager."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-attempt-timeout]] [.property-path]##`quarkus.secretsmanager.api-call-attempt-timeout`## -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]` - +`quarkus.secretsmanager."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.secretsmanager.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.secretsmanager."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-region]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-region[quarkus.secretsmanager.aws.region]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-region]] [.property-path]##`quarkus.secretsmanager.aws.region`## +`quarkus.secretsmanager."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-type]] [.property-path]##`quarkus.secretsmanager.aws.credentials.type`## -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-type]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-type[quarkus.secretsmanager.aws.credentials.type]` - +`quarkus.secretsmanager."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.secretsmanager."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.secretsmanager."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.access-key-id`## +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.secretsmanager.aws.credentials.profile-provider.profile-name`## +`quarkus.secretsmanager."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.secretsmanager."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.secretsmanager."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.secretsmanager."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-command]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.command`## -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]` - +`quarkus.secretsmanager."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.secretsmanager.aws.credentials.custom-provider.name`## +`quarkus.secretsmanager."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-connection-timeout]] [.property-path]##`quarkus.secretsmanager.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-max-connections]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-username]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-password]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-connection-max-idle-time[quarkus.secretsmanager.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-max-concurrency[quarkus.secretsmanager.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-enabled[quarkus.secretsmanager.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-endpoint[quarkus.secretsmanager.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-username]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-username[quarkus.secretsmanager.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-username]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-password]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-password[quarkus.secretsmanager.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-password]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-async-http-transport-configurations]]link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-max-concurrency]] [.property-path]##`quarkus.secretsmanager.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.secretsmanager.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-read-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-write-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-max-idle-time]] [.property-path]##`quarkus.secretsmanager.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.secretsmanager.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tcp-keep-alive]] [.property-path]##`quarkus.secretsmanager.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-protocol]]`link:#quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-protocol[quarkus.secretsmanager.async-client.protocol]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-protocol]] [.property-path]##`quarkus.secretsmanager.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-ssl-provider]] [.property-path]##`quarkus.secretsmanager.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-max-streams]] [.property-path]##`quarkus.secretsmanager.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-initial-window-size]] [.property-path]##`quarkus.secretsmanager.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.secretsmanager.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-override]] [.property-path]##`quarkus.secretsmanager.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.secretsmanager.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.secretsmanager.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.secretsmanager.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-secretsmanager_quarkus-secretsmanager] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-secretsmanager_quarkus-secretsmanager] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager_quarkus.secretsmanager.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager_quarkus.secretsmanager.adoc new file mode 100644 index 000000000..688e7a849 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-secretsmanager_quarkus.secretsmanager.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-secretsmanager_quarkus-secretsmanager +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-telemetry-enabled]] [.property-path]##`quarkus.secretsmanager.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-type]] [.property-path]##`quarkus.secretsmanager.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-type]] [.property-path]##`quarkus.secretsmanager.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-isolated]] [.property-path]##`quarkus.secretsmanager.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-devservices-container-properties-container-properties]] [.property-path]##`quarkus.secretsmanager.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-endpoint-override]] [.property-path]##`quarkus.secretsmanager.endpoint-override`## + +`quarkus.secretsmanager."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-timeout]] [.property-path]##`quarkus.secretsmanager.api-call-timeout`## + +`quarkus.secretsmanager."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-api-call-attempt-timeout]] [.property-path]##`quarkus.secretsmanager.api-call-attempt-timeout`## + +`quarkus.secretsmanager."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.secretsmanager.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.secretsmanager."client-name".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_section_quarkus-secretsmanager-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-region]] [.property-path]##`quarkus.secretsmanager.aws.region`## + +`quarkus.secretsmanager."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-type]] [.property-path]##`quarkus.secretsmanager.aws.credentials.type`## + +`quarkus.secretsmanager."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.secretsmanager."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.secretsmanager."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.access-key-id`## + +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.secret-access-key`## + +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.secretsmanager.aws.credentials.static-provider.session-token`## + +`quarkus.secretsmanager."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.secretsmanager.aws.credentials.profile-provider.profile-name`## + +`quarkus.secretsmanager."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.secretsmanager."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.secretsmanager."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.process-output-limit`## + +`quarkus.secretsmanager."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-process-provider-command]] [.property-path]##`quarkus.secretsmanager.aws.credentials.process-provider.command`## + +`quarkus.secretsmanager."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.secretsmanager.aws.credentials.custom-provider.name`## + +`quarkus.secretsmanager."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-connection-timeout]] [.property-path]##`quarkus.secretsmanager.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-max-connections]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-username]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-password]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.secretsmanager.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-username]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-sync-client-crt-proxy-password]] [.property-path]##`quarkus.secretsmanager.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-secretsmanager_section_quarkus-secretsmanager-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-max-concurrency]] [.property-path]##`quarkus.secretsmanager.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.secretsmanager.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-read-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-write-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-timeout]] [.property-path]##`quarkus.secretsmanager.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.secretsmanager.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tcp-keep-alive]] [.property-path]##`quarkus.secretsmanager.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-protocol]] [.property-path]##`quarkus.secretsmanager.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-ssl-provider]] [.property-path]##`quarkus.secretsmanager.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-max-streams]] [.property-path]##`quarkus.secretsmanager.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-initial-window-size]] [.property-path]##`quarkus.secretsmanager.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-enabled]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-endpoint]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.secretsmanager.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.secretsmanager.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-override]] [.property-path]##`quarkus.secretsmanager.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.secretsmanager.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-secretsmanager_quarkus-secretsmanager-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SECRETSMANAGER_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-secretsmanager_quarkus-secretsmanager] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-secretsmanager_quarkus-secretsmanager] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc index c6fcff6c3..2f9e6763d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-ses +:summaryTableId: quarkus-amazon-ses_quarkus-ses [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-ses_configuration]]link:#quarkus-amazon-ses_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-interceptors]] [.property-path]##`quarkus.ses.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-telemetry-enabled]]`link:#quarkus-amazon-ses_quarkus-ses-telemetry-enabled[quarkus.ses.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-telemetry-enabled]] [.property-path]##`quarkus.ses.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-sync-client-type]] [.property-path]##`quarkus.ses.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-async-client-type]] [.property-path]##`quarkus.ses.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-shared]] [.property-path]##`quarkus.ses.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-isolated]]`link:#quarkus-amazon-ses_quarkus-ses-devservices-isolated[quarkus.ses.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-isolated]] [.property-path]##`quarkus.ses.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-service-name]] [.property-path]##`quarkus.ses.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ses.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-ses_quarkus-ses-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-ses_quarkus-ses-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-ses_section_quarkus-ses]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-ses_quarkus-ses-endpoint-override]]`link:#quarkus-amazon-ses_quarkus-ses-endpoint-override[quarkus.ses.endpoint-override]` +a| [[quarkus-amazon-ses_quarkus-ses-endpoint-override]] [.property-path]##`quarkus.ses.endpoint-override`## +`quarkus.ses."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-ses_quarkus-ses-api-call-timeout]] [.property-path]##`quarkus.ses.api-call-timeout`## -a| [[quarkus-amazon-ses_quarkus-ses-api-call-timeout]]`link:#quarkus-amazon-ses_quarkus-ses-api-call-timeout[quarkus.ses.api-call-timeout]` - +`quarkus.ses."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ses_quarkus-ses-api-call-attempt-timeout]] [.property-path]##`quarkus.ses.api-call-attempt-timeout`## -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]` - +`quarkus.ses."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ses_quarkus-ses-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ses.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.ses."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-ses_section_quarkus-ses-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-ses_quarkus-ses-aws-region]]`link:#quarkus-amazon-ses_quarkus-ses-aws-region[quarkus.ses.aws.region]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-region]] [.property-path]##`quarkus.ses.aws.region`## +`quarkus.ses."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-type]] [.property-path]##`quarkus.ses.aws.credentials.type`## -a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-type]]`link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-type[quarkus.ses.aws.credentials.type]` - +`quarkus.ses."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ses.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.ses."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ses.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.ses."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.access-key-id`## +`quarkus.ses."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.ses."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.ses."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ses_quarkus-ses-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ses.aws.credentials.profile-provider.profile-name`## +`quarkus.ses."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.ses."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.ses."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.ses."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.command`## -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]` - +`quarkus.ses."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ses_quarkus-ses-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-ses_quarkus-ses-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ses.aws.credentials.custom-provider.name`## +`quarkus.ses."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ses_quarkus-ses-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-ses_quarkus-ses-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-connection-timeout]] [.property-path]##`quarkus.ses.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-ses_quarkus-ses-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-ses_quarkus-ses-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-max-connections]] [.property-path]##`quarkus.ses.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ses.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ses.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-ses_quarkus-ses-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-connection-max-idle-time[quarkus.ses.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ses.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-max-concurrency[quarkus.ses.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ses.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-enabled[quarkus.ses.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-endpoint[quarkus.ses.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-username]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-username[quarkus.ses.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-password]]`link:#quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-password[quarkus.ses.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ses_quarkus-ses-async-client-async-http-transport-configurations]]link:#quarkus-amazon-ses_quarkus-ses-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-ses_section_quarkus-ses-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-max-concurrency]] [.property-path]##`quarkus.ses.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ses.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-read-timeout]] [.property-path]##`quarkus.ses.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-write-timeout]] [.property-path]##`quarkus.ses.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-timeout]] [.property-path]##`quarkus.ses.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-max-idle-time]] [.property-path]##`quarkus.ses.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ses.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ses.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ses_quarkus-ses-async-client-protocol]]`link:#quarkus-amazon-ses_quarkus-ses-async-client-protocol[quarkus.ses.async-client.protocol]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-protocol]] [.property-path]##`quarkus.ses.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-ssl-provider]] [.property-path]##`quarkus.ses.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-max-streams]] [.property-path]##`quarkus.ses.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ses.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.ses.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-enabled]] [.property-path]##`quarkus.ses.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-endpoint]] [.property-path]##`quarkus.ses.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ses.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-override]] [.property-path]##`quarkus.ses.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ses.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.ses.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ses_quarkus-ses-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.ses.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-ses_quarkus-ses] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-ses_quarkus-ses] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ses_quarkus.ses.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses_quarkus.ses.adoc new file mode 100644 index 000000000..2f9e6763d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ses_quarkus.ses.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-ses_quarkus-ses +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-telemetry-enabled]] [.property-path]##`quarkus.ses.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-sync-client-type]] [.property-path]##`quarkus.ses.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-async-client-type]] [.property-path]##`quarkus.ses.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-isolated]] [.property-path]##`quarkus.ses.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ses_quarkus-ses-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ses.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-ses_section_quarkus-ses]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-endpoint-override]] [.property-path]##`quarkus.ses.endpoint-override`## + +`quarkus.ses."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ses_quarkus-ses-api-call-timeout]] [.property-path]##`quarkus.ses.api-call-timeout`## + +`quarkus.ses."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ses_quarkus-ses-api-call-attempt-timeout]] [.property-path]##`quarkus.ses.api-call-attempt-timeout`## + +`quarkus.ses."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ses_quarkus-ses-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ses.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.ses."client-name".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_section_quarkus-ses-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-region]] [.property-path]##`quarkus.ses.aws.region`## + +`quarkus.ses."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-type]] [.property-path]##`quarkus.ses.aws.credentials.type`## + +`quarkus.ses."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ses.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.ses."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ses.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.ses."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.access-key-id`## + +`quarkus.ses."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.secret-access-key`## + +`quarkus.ses."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ses.aws.credentials.static-provider.session-token`## + +`quarkus.ses."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ses.aws.credentials.profile-provider.profile-name`## + +`quarkus.ses."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.ses."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.ses."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.process-output-limit`## + +`quarkus.ses."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ses.aws.credentials.process-provider.command`## + +`quarkus.ses."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ses_section_quarkus-ses-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ses.aws.credentials.custom-provider.name`## + +`quarkus.ses."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-connection-timeout]] [.property-path]##`quarkus.ses.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-max-connections]] [.property-path]##`quarkus.ses.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ses.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ses.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ses.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-ses_section_quarkus-ses-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ses.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ses.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ses.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ses_section_quarkus-ses-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-max-concurrency]] [.property-path]##`quarkus.ses.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ses.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-read-timeout]] [.property-path]##`quarkus.ses.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-write-timeout]] [.property-path]##`quarkus.ses.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-timeout]] [.property-path]##`quarkus.ses.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ses.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ses.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-protocol]] [.property-path]##`quarkus.ses.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-ssl-provider]] [.property-path]##`quarkus.ses.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-max-streams]] [.property-path]##`quarkus.ses.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ses.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-enabled]] [.property-path]##`quarkus.ses.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-endpoint]] [.property-path]##`quarkus.ses.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ses.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ses.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-override]] [.property-path]##`quarkus.ses.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ses.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ses_quarkus-ses-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SES_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SES_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-ses_quarkus-ses] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-ses_quarkus-ses] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn.adoc index d1fa143ee..4ed978573 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-sfn +:summaryTableId: quarkus-amazon-sfn_quarkus-sfn [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-sfn_configuration]]link:#quarkus-amazon-sfn_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-interceptors]]`link:#quarkus-amazon-sfn_quarkus-sfn-interceptors[quarkus.sfn.interceptors]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-interceptors]] [.property-path]##`quarkus.sfn.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-telemetry-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-telemetry-enabled[quarkus.sfn.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-telemetry-enabled]] [.property-path]##`quarkus.sfn.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-sync-client-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-type[quarkus.sfn.sync-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-sync-client-type]] [.property-path]##`quarkus.sfn.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-async-client-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-type[quarkus.sfn.async-client.type]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-async-client-type]] [.property-path]##`quarkus.sfn.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-devservices-enabled[quarkus.sfn.devservices.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-enabled]] [.property-path]##`quarkus.sfn.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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-shared]]`link:#quarkus-amazon-sfn_quarkus-sfn-devservices-shared[quarkus.sfn.devservices.shared]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-shared]] [.property-path]##`quarkus.sfn.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-isolated]]`link:#quarkus-amazon-sfn_quarkus-sfn-devservices-isolated[quarkus.sfn.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-isolated]] [.property-path]##`quarkus.sfn.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-service-name]]`link:#quarkus-amazon-sfn_quarkus-sfn-devservices-service-name[quarkus.sfn.devservices.service-name]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-service-name]] [.property-path]##`quarkus.sfn.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-container-properties-container-properties]]`link:#quarkus-amazon-sfn_quarkus-sfn-devservices-container-properties-container-properties[quarkus.sfn.devservices.container-properties."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sfn.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-sfn_quarkus-sfn-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-endpoint-override]]`link:#quarkus-amazon-sfn_quarkus-sfn-endpoint-override[quarkus.sfn.endpoint-override]` +a| [[quarkus-amazon-sfn_quarkus-sfn-endpoint-override]] [.property-path]##`quarkus.sfn.endpoint-override`## +`quarkus.sfn."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-timeout]] [.property-path]##`quarkus.sfn.api-call-timeout`## -a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-api-call-timeout[quarkus.sfn.api-call-timeout]` - +`quarkus.sfn."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-attempt-timeout]] [.property-path]##`quarkus.sfn.api-call-attempt-timeout`## -a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-attempt-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-api-call-attempt-timeout[quarkus.sfn.api-call-attempt-timeout]` - +`quarkus.sfn."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sfn_quarkus-sfn-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sfn.advanced.use-quarkus-scheduled-executor-service`## -a| [[quarkus-amazon-sfn_quarkus-sfn-advanced-use-quarkus-scheduled-executor-service]]`link:#quarkus-amazon-sfn_quarkus-sfn-advanced-use-quarkus-scheduled-executor-service[quarkus.sfn.advanced.use-quarkus-scheduled-executor-service]` - +`quarkus.sfn."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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_SFN_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-aws-services-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-aws-services-configurations[AWS services configurations] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-region]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-region[quarkus.sfn.aws.region]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-region]] [.property-path]##`quarkus.sfn.aws.region`## +`quarkus.sfn."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-type]] [.property-path]##`quarkus.sfn.aws.credentials.type`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-type[quarkus.sfn.aws.credentials.type]` - +`quarkus.sfn."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-async-credential-update-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-async-credential-update-enabled[quarkus.sfn.aws.credentials.default-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.sfn."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.default-provider.reuse-last-provider-enabled`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-reuse-last-provider-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-reuse-last-provider-enabled[quarkus.sfn.aws.credentials.default-provider.reuse-last-provider-enabled]` - +`quarkus.sfn."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-access-key-id]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-access-key-id[quarkus.sfn.aws.credentials.static-provider.access-key-id]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.access-key-id`## +`quarkus.sfn."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.secret-access-key`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-secret-access-key]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-secret-access-key[quarkus.sfn.aws.credentials.static-provider.secret-access-key]` - +`quarkus.sfn."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.session-token`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-session-token]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-session-token[quarkus.sfn.aws.credentials.static-provider.session-token]` - +`quarkus.sfn."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-profile-name]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-profile-name[quarkus.sfn.aws.credentials.profile-provider.profile-name]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sfn.aws.credentials.profile-provider.profile-name`## +`quarkus.sfn."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-async-credential-update-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-async-credential-update-enabled[quarkus.sfn.aws.credentials.process-provider.async-credential-update-enabled]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.sfn."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.credential-refresh-threshold`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-credential-refresh-threshold]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-credential-refresh-threshold[quarkus.sfn.aws.credentials.process-provider.credential-refresh-threshold]` - +`quarkus.sfn."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.process-output-limit`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-output-limit]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-output-limit[quarkus.sfn.aws.credentials.process-provider.process-output-limit]` - +`quarkus.sfn."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.command`## -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-command]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-command[quarkus.sfn.aws.credentials.process-provider.command]` - +`quarkus.sfn."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-name]]`link:#quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-name[quarkus.sfn.aws.credentials.custom-provider.name]` +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sfn.aws.credentials.custom-provider.name`## +`quarkus.sfn."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sfn_quarkus-sfn-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-connection-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-connection-timeout[quarkus.sfn.sync-client.connection-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-connection-timeout]] [.property-path]##`quarkus.sfn.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-socket-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-socket-timeout[quarkus.sfn.sync-client.socket-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-socket-timeout]] [.property-path]##`quarkus.sfn.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-type[quarkus.sfn.sync-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-path[quarkus.sfn.sync-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-type[quarkus.sfn.sync-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-password[quarkus.sfn.sync-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-type[quarkus.sfn.sync-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-path[quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-type[quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-password[quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-acquisition-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-acquisition-timeout[quarkus.sfn.sync-client.apache.connection-acquisition-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.sfn.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-max-idle-time]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-max-idle-time[quarkus.sfn.sync-client.apache.connection-max-idle-time]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.sfn.sync-client.apache.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-time-to-live]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-time-to-live[quarkus.sfn.sync-client.apache.connection-time-to-live]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.sfn.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-max-connections]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-max-connections[quarkus.sfn.sync-client.apache.max-connections]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-max-connections]] [.property-path]##`quarkus.sfn.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-expect-continue-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-expect-continue-enabled[quarkus.sfn.sync-client.apache.expect-continue-enabled]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-use-idle-connection-reaper]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-use-idle-connection-reaper[quarkus.sfn.sync-client.apache.use-idle-connection-reaper]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sfn.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-tcp-keep-alive]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-tcp-keep-alive[quarkus.sfn.sync-client.apache.tcp-keep-alive]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sfn.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-enabled[quarkus.sfn.sync-client.apache.proxy.enabled]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-endpoint]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-endpoint[quarkus.sfn.sync-client.apache.proxy.endpoint]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-username]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-username[quarkus.sfn.sync-client.apache.proxy.username]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-password[quarkus.sfn.sync-client.apache.proxy.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-domain]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-domain[quarkus.sfn.sync-client.apache.proxy.ntlm-domain]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-workstation]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-workstation[quarkus.sfn.sync-client.apache.proxy.ntlm-workstation]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-preemptive-basic-authentication-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-preemptive-basic-authentication-enabled[quarkus.sfn.sync-client.apache.proxy.preemptive-basic-authentication-enabled]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-non-proxy-hosts]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-non-proxy-hosts[quarkus.sfn.sync-client.apache.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-connection-max-idle-time[quarkus.sfn.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sfn.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-max-concurrency[quarkus.sfn.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sfn.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-enabled[quarkus.sfn.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-endpoint[quarkus.sfn.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-username]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-username[quarkus.sfn.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-password[quarkus.sfn.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sfn_quarkus-sfn-async-client-async-http-transport-configurations]]link:#quarkus-amazon-sfn_quarkus-sfn-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-sfn_section_quarkus-sfn-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type h|Default -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-concurrency]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-max-concurrency[quarkus.sfn.async-client.max-concurrency]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-concurrency]] [.property-path]##`quarkus.sfn.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-pending-connection-acquires]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-max-pending-connection-acquires[quarkus.sfn.async-client.max-pending-connection-acquires]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sfn.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-read-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-read-timeout[quarkus.sfn.async-client.read-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-read-timeout]] [.property-path]##`quarkus.sfn.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-write-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-write-timeout[quarkus.sfn.async-client.write-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-write-timeout]] [.property-path]##`quarkus.sfn.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-connection-timeout[quarkus.sfn.async-client.connection-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-timeout]] [.property-path]##`quarkus.sfn.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-acquisition-timeout]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-connection-acquisition-timeout[quarkus.sfn.async-client.connection-acquisition-timeout]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.sfn.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-time-to-live]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-connection-time-to-live[quarkus.sfn.async-client.connection-time-to-live]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-time-to-live]] [.property-path]##`quarkus.sfn.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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-max-idle-time]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-connection-max-idle-time[quarkus.sfn.async-client.connection-max-idle-time]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-max-idle-time]] [.property-path]##`quarkus.sfn.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-use-idle-connection-reaper]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-use-idle-connection-reaper[quarkus.sfn.async-client.use-idle-connection-reaper]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sfn.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tcp-keep-alive]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tcp-keep-alive[quarkus.sfn.async-client.tcp-keep-alive]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sfn.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-protocol]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-protocol[quarkus.sfn.async-client.protocol]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-protocol]] [.property-path]##`quarkus.sfn.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-ssl-provider]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-ssl-provider[quarkus.sfn.async-client.ssl-provider]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-ssl-provider]] [.property-path]##`quarkus.sfn.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-max-streams]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-http2-max-streams[quarkus.sfn.async-client.http2.max-streams]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-max-streams]] [.property-path]##`quarkus.sfn.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-initial-window-size]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-http2-initial-window-size[quarkus.sfn.async-client.http2.initial-window-size]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sfn.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-health-check-ping-period]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-http2-health-check-ping-period[quarkus.sfn.async-client.http2.health-check-ping-period]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.sfn.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-enabled]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-enabled[quarkus.sfn.async-client.proxy.enabled]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-enabled]] [.property-path]##`quarkus.sfn.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-endpoint]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-endpoint[quarkus.sfn.async-client.proxy.endpoint]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-endpoint]] [.property-path]##`quarkus.sfn.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-non-proxy-hosts]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-non-proxy-hosts[quarkus.sfn.async-client.proxy.non-proxy-hosts]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sfn.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-type[quarkus.sfn.async-client.tls-key-managers-provider.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-path]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-path[quarkus.sfn.async-client.tls-key-managers-provider.file-store.path]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-type[quarkus.sfn.async-client.tls-key-managers-provider.file-store.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-password[quarkus.sfn.async-client.tls-key-managers-provider.file-store.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-type[quarkus.sfn.async-client.tls-trust-managers-provider.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-path]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-path[quarkus.sfn.async-client.tls-trust-managers-provider.file-store.path]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-type]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-type[quarkus.sfn.async-client.tls-trust-managers-provider.file-store.type]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-password]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-password[quarkus.sfn.async-client.tls-trust-managers-provider.file-store.password]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-override]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-override[quarkus.sfn.async-client.event-loop.override]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-override]] [.property-path]##`quarkus.sfn.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-number-of-threads]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-number-of-threads[quarkus.sfn.async-client.event-loop.number-of-threads]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sfn.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-thread-name-prefix]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-thread-name-prefix[quarkus.sfn.async-client.event-loop.thread-name-prefix]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.sfn.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-advanced-use-future-completion-thread-pool]]`link:#quarkus-amazon-sfn_quarkus-sfn-async-client-advanced-use-future-completion-thread-pool[quarkus.sfn.async-client.advanced.use-future-completion-thread-pool]` - +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.sfn.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-sfn_quarkus-sfn] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-sfn_quarkus-sfn] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn_quarkus.sfn.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn_quarkus.sfn.adoc new file mode 100644 index 000000000..4ed978573 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sfn_quarkus.sfn.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-sfn_quarkus-sfn +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-interceptors]] [.property-path]##`quarkus.sfn.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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-telemetry-enabled]] [.property-path]##`quarkus.sfn.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-sync-client-type]] [.property-path]##`quarkus.sfn.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-async-client-type]] [.property-path]##`quarkus.sfn.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-enabled]] [.property-path]##`quarkus.sfn.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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-shared]] [.property-path]##`quarkus.sfn.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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-isolated]] [.property-path]##`quarkus.sfn.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-service-name]] [.property-path]##`quarkus.sfn.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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sfn_quarkus-sfn-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sfn.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-sfn_section_quarkus-sfn]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-endpoint-override]] [.property-path]##`quarkus.sfn.endpoint-override`## + +`quarkus.sfn."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-timeout]] [.property-path]##`quarkus.sfn.api-call-timeout`## + +`quarkus.sfn."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-api-call-attempt-timeout]] [.property-path]##`quarkus.sfn.api-call-attempt-timeout`## + +`quarkus.sfn."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sfn.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.sfn."client-name".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_SFN_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-region]] [.property-path]##`quarkus.sfn.aws.region`## + +`quarkus.sfn."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-type]] [.property-path]##`quarkus.sfn.aws.credentials.type`## + +`quarkus.sfn."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.sfn."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.sfn."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.access-key-id`## + +`quarkus.sfn."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.secret-access-key`## + +`quarkus.sfn."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sfn.aws.credentials.static-provider.session-token`## + +`quarkus.sfn."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sfn.aws.credentials.profile-provider.profile-name`## + +`quarkus.sfn."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.sfn."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.sfn."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.process-output-limit`## + +`quarkus.sfn."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sfn.aws.credentials.process-provider.command`## + +`quarkus.sfn."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sfn.aws.credentials.custom-provider.name`## + +`quarkus.sfn."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-connection-timeout]] [.property-path]##`quarkus.sfn.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-socket-timeout]] [.property-path]##`quarkus.sfn.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`quarkus.sfn.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-max-idle-time]] [.property-path]##`quarkus.sfn.sync-client.apache.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-connection-time-to-live]] [.property-path]##`quarkus.sfn.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-max-connections]] [.property-path]##`quarkus.sfn.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sfn.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sfn.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sfn.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sfn.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sfn.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sfn.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sfn_section_quarkus-sfn-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-concurrency]] [.property-path]##`quarkus.sfn.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sfn.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-read-timeout]] [.property-path]##`quarkus.sfn.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-write-timeout]] [.property-path]##`quarkus.sfn.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-timeout]] [.property-path]##`quarkus.sfn.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-acquisition-timeout]] [.property-path]##`quarkus.sfn.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-time-to-live]] [.property-path]##`quarkus.sfn.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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-connection-max-idle-time]] [.property-path]##`quarkus.sfn.async-client.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sfn.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sfn.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-protocol]] [.property-path]##`quarkus.sfn.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-ssl-provider]] [.property-path]##`quarkus.sfn.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-max-streams]] [.property-path]##`quarkus.sfn.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sfn.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.sfn.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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-enabled]] [.property-path]##`quarkus.sfn.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-endpoint]] [.property-path]##`quarkus.sfn.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sfn.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sfn.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-override]] [.property-path]##`quarkus.sfn.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sfn.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.sfn.async-client.event-loop.thread-name-prefix`## + +[.description] +-- +The thread name prefix for threads created by this thread factory used by event loop group. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sfn_quarkus-sfn-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.sfn.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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SFN_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SFN_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-sfn_quarkus-sfn] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-sfn_quarkus-sfn] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc index e233d0110..ebf991b2d 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-sns +:summaryTableId: quarkus-amazon-sns_quarkus-sns [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-sns_configuration]]link:#quarkus-amazon-sns_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-interceptors]] [.property-path]##`quarkus.sns.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-telemetry-enabled]]`link:#quarkus-amazon-sns_quarkus-sns-telemetry-enabled[quarkus.sns.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-telemetry-enabled]] [.property-path]##`quarkus.sns.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-sync-client-type]] [.property-path]##`quarkus.sns.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-async-client-type]] [.property-path]##`quarkus.sns.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-shared]] [.property-path]##`quarkus.sns.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-isolated]]`link:#quarkus-amazon-sns_quarkus-sns-devservices-isolated[quarkus.sns.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-isolated]] [.property-path]##`quarkus.sns.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-service-name]] [.property-path]##`quarkus.sns.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sns.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-sns_quarkus-sns-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-sns_quarkus-sns-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-sns_section_quarkus-sns]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-sns_quarkus-sns-endpoint-override]]`link:#quarkus-amazon-sns_quarkus-sns-endpoint-override[quarkus.sns.endpoint-override]` +a| [[quarkus-amazon-sns_quarkus-sns-endpoint-override]] [.property-path]##`quarkus.sns.endpoint-override`## +`quarkus.sns."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-sns_quarkus-sns-api-call-timeout]] [.property-path]##`quarkus.sns.api-call-timeout`## -a| [[quarkus-amazon-sns_quarkus-sns-api-call-timeout]]`link:#quarkus-amazon-sns_quarkus-sns-api-call-timeout[quarkus.sns.api-call-timeout]` - +`quarkus.sns."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sns_quarkus-sns-api-call-attempt-timeout]] [.property-path]##`quarkus.sns.api-call-attempt-timeout`## -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]` - +`quarkus.sns."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sns_quarkus-sns-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sns.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.sns."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-sns_section_quarkus-sns-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-sns_quarkus-sns-aws-region]]`link:#quarkus-amazon-sns_quarkus-sns-aws-region[quarkus.sns.aws.region]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-region]] [.property-path]##`quarkus.sns.aws.region`## +`quarkus.sns."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-type]] [.property-path]##`quarkus.sns.aws.credentials.type`## -a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-type]]`link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-type[quarkus.sns.aws.credentials.type]` - +`quarkus.sns."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.sns."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.sns."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.access-key-id`## +`quarkus.sns."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.sns."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.sns."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sns_quarkus-sns-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sns.aws.credentials.profile-provider.profile-name`## +`quarkus.sns."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.sns."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.sns."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.sns."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.command`## -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]` - +`quarkus.sns."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sns_quarkus-sns-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-sns_quarkus-sns-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sns.aws.credentials.custom-provider.name`## +`quarkus.sns."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sns_quarkus-sns-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-sns_quarkus-sns-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-connection-timeout]] [.property-path]##`quarkus.sns.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-sns_quarkus-sns-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-sns_quarkus-sns-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-max-connections]] [.property-path]##`quarkus.sns.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sns.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sns.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-sns_quarkus-sns-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-connection-max-idle-time[quarkus.sns.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sns.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-max-concurrency[quarkus.sns.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sns.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-enabled[quarkus.sns.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-endpoint[quarkus.sns.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-username]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-username[quarkus.sns.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-password]]`link:#quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-password[quarkus.sns.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sns_quarkus-sns-async-client-async-http-transport-configurations]]link:#quarkus-amazon-sns_quarkus-sns-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-sns_section_quarkus-sns-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-max-concurrency]] [.property-path]##`quarkus.sns.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sns.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-read-timeout]] [.property-path]##`quarkus.sns.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-write-timeout]] [.property-path]##`quarkus.sns.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-timeout]] [.property-path]##`quarkus.sns.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-max-idle-time]] [.property-path]##`quarkus.sns.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sns.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sns.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sns_quarkus-sns-async-client-protocol]]`link:#quarkus-amazon-sns_quarkus-sns-async-client-protocol[quarkus.sns.async-client.protocol]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-protocol]] [.property-path]##`quarkus.sns.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-ssl-provider]] [.property-path]##`quarkus.sns.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-max-streams]] [.property-path]##`quarkus.sns.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sns.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.sns.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-enabled]] [.property-path]##`quarkus.sns.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-endpoint]] [.property-path]##`quarkus.sns.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sns.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-override]] [.property-path]##`quarkus.sns.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sns.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.sns.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sns_quarkus-sns-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.sns.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-sns_quarkus-sns] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-sns_quarkus-sns] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sns_quarkus.sns.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns_quarkus.sns.adoc new file mode 100644 index 000000000..ebf991b2d --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sns_quarkus.sns.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-sns_quarkus-sns +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-telemetry-enabled]] [.property-path]##`quarkus.sns.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-sync-client-type]] [.property-path]##`quarkus.sns.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-async-client-type]] [.property-path]##`quarkus.sns.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-isolated]] [.property-path]##`quarkus.sns.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sns_quarkus-sns-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sns.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-sns_section_quarkus-sns]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-endpoint-override]] [.property-path]##`quarkus.sns.endpoint-override`## + +`quarkus.sns."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sns_quarkus-sns-api-call-timeout]] [.property-path]##`quarkus.sns.api-call-timeout`## + +`quarkus.sns."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sns_quarkus-sns-api-call-attempt-timeout]] [.property-path]##`quarkus.sns.api-call-attempt-timeout`## + +`quarkus.sns."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sns_quarkus-sns-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sns.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.sns."client-name".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_section_quarkus-sns-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-region]] [.property-path]##`quarkus.sns.aws.region`## + +`quarkus.sns."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-type]] [.property-path]##`quarkus.sns.aws.credentials.type`## + +`quarkus.sns."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.sns."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.sns."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.access-key-id`## + +`quarkus.sns."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.secret-access-key`## + +`quarkus.sns."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sns.aws.credentials.static-provider.session-token`## + +`quarkus.sns."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sns.aws.credentials.profile-provider.profile-name`## + +`quarkus.sns."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.sns."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.sns."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.process-output-limit`## + +`quarkus.sns."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sns.aws.credentials.process-provider.command`## + +`quarkus.sns."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sns_section_quarkus-sns-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sns.aws.credentials.custom-provider.name`## + +`quarkus.sns."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-connection-timeout]] [.property-path]##`quarkus.sns.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-max-connections]] [.property-path]##`quarkus.sns.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sns.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sns.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sns.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-sns_section_quarkus-sns-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sns.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sns.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sns.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sns_section_quarkus-sns-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-max-concurrency]] [.property-path]##`quarkus.sns.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sns.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-read-timeout]] [.property-path]##`quarkus.sns.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-write-timeout]] [.property-path]##`quarkus.sns.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-timeout]] [.property-path]##`quarkus.sns.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sns.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sns.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-protocol]] [.property-path]##`quarkus.sns.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-ssl-provider]] [.property-path]##`quarkus.sns.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-max-streams]] [.property-path]##`quarkus.sns.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sns.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-enabled]] [.property-path]##`quarkus.sns.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-endpoint]] [.property-path]##`quarkus.sns.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sns.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sns.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-override]] [.property-path]##`quarkus.sns.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sns.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sns_quarkus-sns-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-sns_quarkus-sns] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-sns_quarkus-sns] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc index dbdd0bf5b..64bbc2960 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-sqs +:summaryTableId: quarkus-amazon-sqs_quarkus-sqs [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-sqs_configuration]]link:#quarkus-amazon-sqs_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-interceptors]] [.property-path]##`quarkus.sqs.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-telemetry-enabled]]`link:#quarkus-amazon-sqs_quarkus-sqs-telemetry-enabled[quarkus.sqs.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-telemetry-enabled]] [.property-path]##`quarkus.sqs.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-sync-client-type]] [.property-path]##`quarkus.sqs.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-async-client-type]] [.property-path]##`quarkus.sqs.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-shared]] [.property-path]##`quarkus.sqs.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-isolated]]`link:#quarkus-amazon-sqs_quarkus-sqs-devservices-isolated[quarkus.sqs.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-isolated]] [.property-path]##`quarkus.sqs.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-service-name]] [.property-path]##`quarkus.sqs.devservices.service-name`## [.description] -- @@ -146,58 +141,58 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sqs.devservices.container-properties."container-properties"`## [.description] -- -The queues to create on startup. +Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_QUEUES+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SQS_DEVSERVICES_QUEUES+++` +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|Map | - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-queues]] [.property-path]##`quarkus.sqs.devservices.queues`## [.description] -- -Generic properties that are pass for additional container configuration. +The queues to create on startup. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_QUEUES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_QUEUES+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|list of string | - -h|[[quarkus-amazon-sqs_quarkus-sqs-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-sqs_quarkus-sqs-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-sqs_quarkus-sqs-endpoint-override]]`link:#quarkus-amazon-sqs_quarkus-sqs-endpoint-override[quarkus.sqs.endpoint-override]` +a| [[quarkus-amazon-sqs_quarkus-sqs-endpoint-override]] [.property-path]##`quarkus.sqs.endpoint-override`## +`quarkus.sqs."client-name".endpoint-override` [.description] -- @@ -205,19 +200,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-sqs_quarkus-sqs-api-call-timeout]] [.property-path]##`quarkus.sqs.api-call-timeout`## -a| [[quarkus-amazon-sqs_quarkus-sqs-api-call-timeout]]`link:#quarkus-amazon-sqs_quarkus-sqs-api-call-timeout[quarkus.sqs.api-call-timeout]` - +`quarkus.sqs."client-name".api-call-timeout` [.description] -- @@ -227,19 +223,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sqs_quarkus-sqs-api-call-attempt-timeout]] [.property-path]##`quarkus.sqs.api-call-attempt-timeout`## -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]` - +`quarkus.sqs."client-name".api-call-attempt-timeout` [.description] -- @@ -247,19 +244,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sqs_quarkus-sqs-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sqs.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.sqs."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -267,23 +265,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-sqs_section_quarkus-sqs-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-sqs_quarkus-sqs-aws-region]]`link:#quarkus-amazon-sqs_quarkus-sqs-aws-region[quarkus.sqs.aws.region]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-region]] [.property-path]##`quarkus.sqs.aws.region`## +`quarkus.sqs."client-name".aws.region` [.description] -- @@ -300,18 +300,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-type]] [.property-path]##`quarkus.sqs.aws.credentials.type`## -a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-type]]`link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-type[quarkus.sqs.aws.credentials.type]` - +`quarkus.sqs."client-name".aws.credentials.type` [.description] -- @@ -340,24 +342,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.sqs."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -365,18 +367,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.sqs."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -384,79 +388,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.access-key-id`## +`quarkus.sqs."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.sqs."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.sqs."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sqs.aws.credentials.profile-provider.profile-name`## +`quarkus.sqs."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -464,23 +476,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.sqs."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -488,18 +502,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.sqs."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -507,116 +523,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.sqs."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.command`## -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]` - +`quarkus.sqs."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-sqs_quarkus-sqs-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sqs.aws.credentials.custom-provider.name`## +`quarkus.sqs."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sqs_quarkus-sqs-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-connection-timeout]] [.property-path]##`quarkus.sqs.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -630,36 +650,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -667,35 +686,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -709,36 +728,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -746,94 +764,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-max-connections]] [.property-path]##`quarkus.sqs.sync-client.apache.max-connections`## [.description] -- @@ -841,35 +855,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sqs.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -877,52 +891,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sqs.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.endpoint`## [.description] -- @@ -930,178 +944,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-connection-max-idle-time[quarkus.sqs.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sqs.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-max-concurrency[quarkus.sqs.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sqs.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-enabled[quarkus.sqs.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-endpoint[quarkus.sqs.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1109,58 +1121,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-username]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-username[quarkus.sqs.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-password]]`link:#quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-password[quarkus.sqs.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sqs_quarkus-sqs-async-client-async-http-transport-configurations]]link:#quarkus-amazon-sqs_quarkus-sqs-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-sqs_section_quarkus-sqs-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-max-concurrency]] [.property-path]##`quarkus.sqs.async-client.max-concurrency`## [.description] -- @@ -1168,18 +1180,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sqs.async-client.max-pending-connection-acquires`## [.description] -- @@ -1187,18 +1199,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-read-timeout]] [.property-path]##`quarkus.sqs.async-client.read-timeout`## [.description] -- @@ -1206,19 +1218,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-write-timeout]] [.property-path]##`quarkus.sqs.async-client.write-timeout`## [.description] -- @@ -1226,73 +1237,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-timeout]] [.property-path]##`quarkus.sqs.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-max-idle-time]] [.property-path]##`quarkus.sqs.async-client.connection-max-idle-time`## [.description] -- @@ -1300,19 +1307,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sqs.async-client.use-idle-connection-reaper`## [.description] -- @@ -1320,53 +1326,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sqs.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-protocol]]`link:#quarkus-amazon-sqs_quarkus-sqs-async-client-protocol[quarkus.sqs.async-client.protocol]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-protocol]] [.property-path]##`quarkus.sqs.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-ssl-provider]] [.property-path]##`quarkus.sqs.async-client.ssl-provider`## [.description] -- @@ -1374,19 +1379,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-max-streams]] [.property-path]##`quarkus.sqs.async-client.http2.max-streams`## [.description] -- @@ -1394,18 +1398,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sqs.async-client.http2.initial-window-size`## [.description] -- @@ -1413,18 +1417,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.sqs.async-client.http2.health-check-ping-period`## [.description] -- @@ -1432,36 +1436,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-enabled]] [.property-path]##`quarkus.sqs.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-endpoint]] [.property-path]##`quarkus.sqs.async-client.proxy.endpoint`## [.description] -- @@ -1469,36 +1472,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sqs.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1512,36 +1514,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1549,35 +1550,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1591,36 +1592,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1628,52 +1628,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-override]] [.property-path]##`quarkus.sqs.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sqs.async-client.event-loop.number-of-threads`## [.description] -- @@ -1681,18 +1681,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.sqs.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1702,18 +1702,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.sqs.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1721,19 +1721,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-sqs_quarkus-sqs] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1750,11 +1754,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-sqs_quarkus-sqs] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs_quarkus.sqs.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs_quarkus.sqs.adoc new file mode 100644 index 000000000..64bbc2960 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sqs_quarkus.sqs.adoc @@ -0,0 +1,1768 @@ +:summaryTableId: quarkus-amazon-sqs_quarkus-sqs +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-telemetry-enabled]] [.property-path]##`quarkus.sqs.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-sync-client-type]] [.property-path]##`quarkus.sqs.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-async-client-type]] [.property-path]##`quarkus.sqs.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-isolated]] [.property-path]##`quarkus.sqs.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sqs.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sqs_quarkus-sqs-devservices-queues]] [.property-path]##`quarkus.sqs.devservices.queues`## + +[.description] +-- +The queues to create on startup. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_DEVSERVICES_QUEUES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_DEVSERVICES_QUEUES+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +h|[[quarkus-amazon-sqs_section_quarkus-sqs]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-endpoint-override]] [.property-path]##`quarkus.sqs.endpoint-override`## + +`quarkus.sqs."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-api-call-timeout]] [.property-path]##`quarkus.sqs.api-call-timeout`## + +`quarkus.sqs."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-api-call-attempt-timeout]] [.property-path]##`quarkus.sqs.api-call-attempt-timeout`## + +`quarkus.sqs."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sqs.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.sqs."client-name".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_section_quarkus-sqs-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-region]] [.property-path]##`quarkus.sqs.aws.region`## + +`quarkus.sqs."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-type]] [.property-path]##`quarkus.sqs.aws.credentials.type`## + +`quarkus.sqs."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.sqs."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.sqs."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.access-key-id`## + +`quarkus.sqs."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.secret-access-key`## + +`quarkus.sqs."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sqs.aws.credentials.static-provider.session-token`## + +`quarkus.sqs."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sqs.aws.credentials.profile-provider.profile-name`## + +`quarkus.sqs."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.sqs."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.sqs."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.process-output-limit`## + +`quarkus.sqs."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sqs.aws.credentials.process-provider.command`## + +`quarkus.sqs."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sqs.aws.credentials.custom-provider.name`## + +`quarkus.sqs."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-connection-timeout]] [.property-path]##`quarkus.sqs.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-max-connections]] [.property-path]##`quarkus.sqs.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sqs.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sqs.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sqs.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sqs.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sqs.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sqs.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sqs_section_quarkus-sqs-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-max-concurrency]] [.property-path]##`quarkus.sqs.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sqs.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-read-timeout]] [.property-path]##`quarkus.sqs.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-write-timeout]] [.property-path]##`quarkus.sqs.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-timeout]] [.property-path]##`quarkus.sqs.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sqs.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sqs.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-protocol]] [.property-path]##`quarkus.sqs.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-ssl-provider]] [.property-path]##`quarkus.sqs.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-max-streams]] [.property-path]##`quarkus.sqs.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sqs.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-enabled]] [.property-path]##`quarkus.sqs.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-endpoint]] [.property-path]##`quarkus.sqs.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sqs.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sqs.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-override]] [.property-path]##`quarkus.sqs.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sqs.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sqs_quarkus-sqs-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SQS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SQS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-sqs_quarkus-sqs] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-sqs_quarkus-sqs] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc index 2b4959417..72b9400d9 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-ssm +:summaryTableId: quarkus-amazon-ssm_quarkus-ssm [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-ssm_configuration]]link:#quarkus-amazon-ssm_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-interceptors]] [.property-path]##`quarkus.ssm.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-telemetry-enabled]]`link:#quarkus-amazon-ssm_quarkus-ssm-telemetry-enabled[quarkus.ssm.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-telemetry-enabled]] [.property-path]##`quarkus.ssm.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-sync-client-type]] [.property-path]##`quarkus.ssm.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-async-client-type]] [.property-path]##`quarkus.ssm.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-shared]] [.property-path]##`quarkus.ssm.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-isolated]]`link:#quarkus-amazon-ssm_quarkus-ssm-devservices-isolated[quarkus.ssm.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-isolated]] [.property-path]##`quarkus.ssm.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-service-name]] [.property-path]##`quarkus.ssm.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ssm.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-ssm_quarkus-ssm-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-ssm_quarkus-ssm-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-ssm_quarkus-ssm-endpoint-override]]`link:#quarkus-amazon-ssm_quarkus-ssm-endpoint-override[quarkus.ssm.endpoint-override]` +a| [[quarkus-amazon-ssm_quarkus-ssm-endpoint-override]] [.property-path]##`quarkus.ssm.endpoint-override`## +`quarkus.ssm."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-ssm_quarkus-ssm-api-call-timeout]] [.property-path]##`quarkus.ssm.api-call-timeout`## -a| [[quarkus-amazon-ssm_quarkus-ssm-api-call-timeout]]`link:#quarkus-amazon-ssm_quarkus-ssm-api-call-timeout[quarkus.ssm.api-call-timeout]` - +`quarkus.ssm."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ssm_quarkus-ssm-api-call-attempt-timeout]] [.property-path]##`quarkus.ssm.api-call-attempt-timeout`## -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]` - +`quarkus.ssm."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-ssm_quarkus-ssm-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ssm.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.ssm."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-ssm_section_quarkus-ssm-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-ssm_quarkus-ssm-aws-region]]`link:#quarkus-amazon-ssm_quarkus-ssm-aws-region[quarkus.ssm.aws.region]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-region]] [.property-path]##`quarkus.ssm.aws.region`## +`quarkus.ssm."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-type]] [.property-path]##`quarkus.ssm.aws.credentials.type`## -a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-type]]`link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-type[quarkus.ssm.aws.credentials.type]` - +`quarkus.ssm."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.ssm."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.ssm."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.access-key-id`## +`quarkus.ssm."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.ssm."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.ssm."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ssm.aws.credentials.profile-provider.profile-name`## +`quarkus.ssm."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.ssm."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.ssm."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.ssm."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.command`## -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]` - +`quarkus.ssm."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-ssm_quarkus-ssm-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ssm.aws.credentials.custom-provider.name`## +`quarkus.ssm."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ssm_quarkus-ssm-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-connection-timeout]] [.property-path]##`quarkus.ssm.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-max-connections]] [.property-path]##`quarkus.ssm.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ssm.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ssm.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-connection-max-idle-time[quarkus.ssm.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ssm.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-max-concurrency[quarkus.ssm.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ssm.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-enabled[quarkus.ssm.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-endpoint[quarkus.ssm.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-username]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-username[quarkus.ssm.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-password]]`link:#quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-password[quarkus.ssm.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-ssm_quarkus-ssm-async-client-async-http-transport-configurations]]link:#quarkus-amazon-ssm_quarkus-ssm-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-ssm_section_quarkus-ssm-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-max-concurrency]] [.property-path]##`quarkus.ssm.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ssm.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-read-timeout]] [.property-path]##`quarkus.ssm.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-write-timeout]] [.property-path]##`quarkus.ssm.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-timeout]] [.property-path]##`quarkus.ssm.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-max-idle-time]] [.property-path]##`quarkus.ssm.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ssm.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ssm.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-protocol]]`link:#quarkus-amazon-ssm_quarkus-ssm-async-client-protocol[quarkus.ssm.async-client.protocol]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-protocol]] [.property-path]##`quarkus.ssm.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-ssl-provider]] [.property-path]##`quarkus.ssm.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-max-streams]] [.property-path]##`quarkus.ssm.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ssm.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.ssm.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-enabled]] [.property-path]##`quarkus.ssm.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-endpoint]] [.property-path]##`quarkus.ssm.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ssm.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-override]] [.property-path]##`quarkus.ssm.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ssm.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.ssm.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.ssm.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-ssm_quarkus-ssm] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-ssm_quarkus-ssm] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm_quarkus.ssm.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm_quarkus.ssm.adoc new file mode 100644 index 000000000..72b9400d9 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-ssm_quarkus.ssm.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-ssm_quarkus-ssm +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-telemetry-enabled]] [.property-path]##`quarkus.ssm.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-sync-client-type]] [.property-path]##`quarkus.ssm.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-async-client-type]] [.property-path]##`quarkus.ssm.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-isolated]] [.property-path]##`quarkus.ssm.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-ssm_quarkus-ssm-devservices-container-properties-container-properties]] [.property-path]##`quarkus.ssm.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-ssm_section_quarkus-ssm]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-endpoint-override]] [.property-path]##`quarkus.ssm.endpoint-override`## + +`quarkus.ssm."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-api-call-timeout]] [.property-path]##`quarkus.ssm.api-call-timeout`## + +`quarkus.ssm."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-api-call-attempt-timeout]] [.property-path]##`quarkus.ssm.api-call-attempt-timeout`## + +`quarkus.ssm."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.ssm.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.ssm."client-name".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_section_quarkus-ssm-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-region]] [.property-path]##`quarkus.ssm.aws.region`## + +`quarkus.ssm."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-type]] [.property-path]##`quarkus.ssm.aws.credentials.type`## + +`quarkus.ssm."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.ssm."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.ssm."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.access-key-id`## + +`quarkus.ssm."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.secret-access-key`## + +`quarkus.ssm."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.ssm.aws.credentials.static-provider.session-token`## + +`quarkus.ssm."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.ssm.aws.credentials.profile-provider.profile-name`## + +`quarkus.ssm."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.ssm."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.ssm."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.process-output-limit`## + +`quarkus.ssm."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-process-provider-command]] [.property-path]##`quarkus.ssm.aws.credentials.process-provider.command`## + +`quarkus.ssm."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.ssm.aws.credentials.custom-provider.name`## + +`quarkus.ssm."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-connection-timeout]] [.property-path]##`quarkus.ssm.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-max-connections]] [.property-path]##`quarkus.ssm.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.ssm.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.ssm.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-username]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-password]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ssm.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.ssm.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.ssm.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-username]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-sync-client-crt-proxy-password]] [.property-path]##`quarkus.ssm.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-ssm_section_quarkus-ssm-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-max-concurrency]] [.property-path]##`quarkus.ssm.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.ssm.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-read-timeout]] [.property-path]##`quarkus.ssm.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-write-timeout]] [.property-path]##`quarkus.ssm.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-timeout]] [.property-path]##`quarkus.ssm.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.ssm.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tcp-keep-alive]] [.property-path]##`quarkus.ssm.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-protocol]] [.property-path]##`quarkus.ssm.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-ssl-provider]] [.property-path]##`quarkus.ssm.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-max-streams]] [.property-path]##`quarkus.ssm.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-initial-window-size]] [.property-path]##`quarkus.ssm.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-enabled]] [.property-path]##`quarkus.ssm.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-endpoint]] [.property-path]##`quarkus.ssm.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.ssm.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.ssm.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-override]] [.property-path]##`quarkus.ssm.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.ssm.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-ssm_quarkus-ssm-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SSM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SSM_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-ssm_quarkus-ssm] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-ssm_quarkus-ssm] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc index 0aa826199..d028967ad 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts.adoc @@ -1,17 +1,14 @@ - -:summaryTableId: quarkus-amazon-sts +:summaryTableId: quarkus-amazon-sts_quarkus-sts [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime [.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-amazon-sts_configuration]]link:#quarkus-amazon-sts_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-interceptors]] [.property-path]##`quarkus.sts.interceptors`## [.description] -- @@ -19,88 +16,86 @@ List of execution interceptors that will have access to read and modify the requ The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_INTERCEPTORS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_INTERCEPTORS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-telemetry-enabled]]`link:#quarkus-amazon-sts_quarkus-sts-telemetry-enabled[quarkus.sts.telemetry.enabled]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-telemetry-enabled]] [.property-path]##`quarkus.sts.telemetry.enabled`## [.description] -- OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-sync-client-type]] [.property-path]##`quarkus.sts.sync-client.type`## [.description] -- Type of the sync HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`url`, `apache`, `aws-crt` +-- +a|SyncClientType |`url` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-async-client-type]] [.property-path]##`quarkus.sts.async-client.type`## [.description] -- Type of the async HTTP client implementation + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`netty`, `aws-crt` +-- +a|AsyncClientType |`netty` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_DEVSERVICES_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-shared]] [.property-path]##`quarkus.sts.devservices.shared`## [.description] -- @@ -110,35 +105,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_DEVSERVICES_SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-isolated]]`link:#quarkus-amazon-sts_quarkus-sts-devservices-isolated[quarkus.sts.devservices.isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-isolated]] [.property-path]##`quarkus.sts.devservices.isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_DEVSERVICES_ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-service-name]] [.property-path]##`quarkus.sts.devservices.service-name`## [.description] -- @@ -146,41 +141,41 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_DEVSERVICES_SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sts.devservices.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -h|[[quarkus-amazon-sts_quarkus-sts-sdk-aws-sdk-client-configurations]]link:#quarkus-amazon-sts_quarkus-sts-sdk-aws-sdk-client-configurations[AWS SDK client configurations] - +h|[[quarkus-amazon-sts_section_quarkus-sts]] [.section-name.section-level0]##AWS SDK client configurations## h|Type h|Default -a| [[quarkus-amazon-sts_quarkus-sts-endpoint-override]]`link:#quarkus-amazon-sts_quarkus-sts-endpoint-override[quarkus.sts.endpoint-override]` +a| [[quarkus-amazon-sts_quarkus-sts-endpoint-override]] [.property-path]##`quarkus.sts.endpoint-override`## +`quarkus.sts."client-name".endpoint-override` [.description] -- @@ -188,19 +183,20 @@ The endpoint URI with which the SDK should communicate. If not specified, an appropriate endpoint to be used for the given service and region. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ENDPOINT_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ENDPOINT_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | +a| [[quarkus-amazon-sts_quarkus-sts-api-call-timeout]] [.property-path]##`quarkus.sts.api-call-timeout`## -a| [[quarkus-amazon-sts_quarkus-sts-api-call-timeout]]`link:#quarkus-amazon-sts_quarkus-sts-api-call-timeout[quarkus.sts.api-call-timeout]` - +`quarkus.sts."client-name".api-call-timeout` [.description] -- @@ -210,19 +206,20 @@ This timeout covers the entire client execution except for marshalling. This inc This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_API_CALL_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_API_CALL_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sts_quarkus-sts-api-call-attempt-timeout]] [.property-path]##`quarkus.sts.api-call-attempt-timeout`## -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]` - +`quarkus.sts."client-name".api-call-attempt-timeout` [.description] -- @@ -230,19 +227,20 @@ The amount of time to wait for the HTTP request to complete before giving up and This value should always be positive, if present. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_API_CALL_ATTEMPT_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_API_CALL_ATTEMPT_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | +a| [[quarkus-amazon-sts_quarkus-sts-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sts.advanced.use-quarkus-scheduled-executor-service`## -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]` - +`quarkus.sts."client-name".advanced.use-quarkus-scheduled-executor-service` [.description] -- @@ -250,23 +248,25 @@ Whether the Quarkus thread pool should be used for scheduling tasks such as asyn 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 +-- +|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|[[quarkus-amazon-sts_section_quarkus-sts-aws]] [.section-name.section-level0]##AWS services configurations## h|Type h|Default -a| [[quarkus-amazon-sts_quarkus-sts-aws-region]]`link:#quarkus-amazon-sts_quarkus-sts-aws-region[quarkus.sts.aws.region]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-region]] [.property-path]##`quarkus.sts.aws.region`## +`quarkus.sts."client-name".aws.region` [.description] -- @@ -283,18 +283,20 @@ If not set, region is retrieved via the default providers chain in the following See `software.amazon.awssdk.regions.Region` for available regions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_REGION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_REGION+++` endif::add-copy-button-to-env-var[] ---|Region +-- +|Region | +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-type]] [.property-path]##`quarkus.sts.aws.credentials.type`## -a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-type]]`link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-type[quarkus.sts.aws.credentials.type]` - +`quarkus.sts."client-name".aws.credentials.type` [.description] -- @@ -323,24 +325,24 @@ Available values: * `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will fail unless the resource or API's policy has been configured to specifically allow anonymous access. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`default`, `static`, `system-property`, `env-variable`, `profile`, `container`, `instance-profile`, `process`, `custom`, `anonymous` +-- +a|AwsCredentialsProviderType |`default` - -h|[[quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-default-credentials-provider-configuration]]link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-default-credentials-provider-configuration[Default credentials provider configuration] - +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sts.aws.credentials.default-provider.async-credential-update-enabled`## +`quarkus.sts."client-name".aws.credentials.default-provider.async-credential-update-enabled` [.description] -- @@ -348,18 +350,20 @@ Whether this provider should fetch credentials asynchronously in the background. If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sts.aws.credentials.default-provider.reuse-last-provider-enabled`## -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]` - +`quarkus.sts."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` [.description] -- @@ -367,79 +371,87 @@ Whether the provider should reuse the last successful credentials provider in th Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` -h|[[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-static-credentials-provider-configuration]]link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-static-credentials-provider-configuration[Static credentials provider configuration] - +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.access-key-id`## +`quarkus.sts."client-name".aws.credentials.static-provider.access-key-id` [.description] -- AWS Access key id + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.secret-access-key`## -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]` - +`quarkus.sts."client-name".aws.credentials.static-provider.secret-access-key` [.description] -- AWS Secret access key + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.session-token`## -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]` - +`quarkus.sts."client-name".aws.credentials.static-provider.session-token` [.description] -- AWS Session token + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sts_quarkus-sts-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration]]link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-profile-provider-aws-profile-credentials-provider-configuration[AWS Profile credentials provider configuration] - +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sts.aws.credentials.profile-provider.profile-name`## +`quarkus.sts."client-name".aws.credentials.profile-provider.profile-name` [.description] -- @@ -447,23 +459,25 @@ The name of the profile that should be used by this credentials provider. If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-process-credentials-provider-configuration]]link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-process-credentials-provider-configuration[Process credentials provider configuration] - +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.async-credential-update-enabled`## +`quarkus.sts."client-name".aws.credentials.process-provider.async-credential-update-enabled` [.description] -- @@ -471,18 +485,20 @@ Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.credential-refresh-threshold`## -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]` - +`quarkus.sts."client-name".aws.credentials.process-provider.credential-refresh-threshold` [.description] -- @@ -490,116 +506,120 @@ The amount of time between when the credentials expire and when the credentials This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`15S` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.process-output-limit`## -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]` - +`quarkus.sts."client-name".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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` endif::add-copy-button-to-env-var[] ---|MemorySize link:#memory-size-note-anchor[icon:question-circle[title=More information about the MemorySize format]] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] |`1024` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.command`## -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]` - +`quarkus.sts."client-name".aws.credentials.process-provider.command` [.description] -- The command that should be executed to retrieve credentials. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sts_quarkus-sts-aws-credentials-custom-provider-custom-credentials-provider-configuration]]link:#quarkus-amazon-sts_quarkus-sts-aws-credentials-custom-provider-custom-credentials-provider-configuration[Custom credentials provider configuration] - +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## h|Type 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]` +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sts.aws.credentials.custom-provider.name`## +`quarkus.sts."client-name".aws.credentials.custom-provider.name` [.description] -- The name of custom AwsCredentialsProvider bean. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sts_quarkus-sts-sync-client-sync-http-transport-configurations]]link:#quarkus-amazon-sts_quarkus-sts-sync-client-sync-http-transport-configurations[Sync HTTP transport configurations] +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-connection-timeout]] [.property-path]##`quarkus.sts.sync-client.connection-timeout`## [.description] -- The maximum amount of time to establish a connection before timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-socket-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_SOCKET_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.type`## [.description] -- @@ -613,36 +633,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -650,35 +669,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.type`## [.description] -- @@ -692,36 +711,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -729,94 +747,90 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -h|[[quarkus-amazon-sts_quarkus-sts-sync-client-apache-apache-http-client-specific-configurations]]link:#quarkus-amazon-sts_quarkus-sts-sync-client-apache-apache-http-client-specific-configurations[Apache HTTP client specific configurations] - +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## h|Type 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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-max-connections]] [.property-path]##`quarkus.sts.sync-client.apache.max-connections`## [.description] -- @@ -824,35 +838,35 @@ The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.expect-continue-enabled`## [.description] -- Whether the client should send an HTTP expect-continue handshake before each request. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sts.sync-client.apache.use-idle-connection-reaper`## [.description] -- @@ -860,52 +874,52 @@ Whether the idle connections in the connection pool should be closed asynchronou When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sts.sync-client.apache.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.endpoint`## [.description] -- @@ -913,178 +927,176 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.ntlm-domain`## [.description] -- For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.ntlm-workstation`## [.description] -- For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## [.description] -- Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | -h|[[quarkus-amazon-sts_quarkus-sts-sync-client-crt-aws-crt-based-http-client-specific-configurations]]link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-aws-crt-based-http-client-specific-configurations[AWS CRT-based HTTP client specific configurations] - +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## h|Type h|Default -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-connection-max-idle-time]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-connection-max-idle-time[quarkus.sts.sync-client.crt.connection-max-idle-time]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sts.sync-client.crt.connection-max-idle-time`## [.description] -- The maximum amount of time that a connection should be allowed to remain open while idle. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`60S` - -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-max-concurrency]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-max-concurrency[quarkus.sts.sync-client.crt.max-concurrency]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sts.sync-client.crt.max-concurrency`## [.description] -- The maximum number of allowed concurrent requests. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-enabled]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-enabled[quarkus.sts.sync-client.crt.proxy.enabled]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.enabled`## [.description] -- Enable HTTP proxy + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-endpoint]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-endpoint[quarkus.sts.sync-client.crt.proxy.endpoint]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.endpoint`## [.description] -- @@ -1092,58 +1104,58 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-username]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-username[quarkus.sts.sync-client.crt.proxy.username]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.username`## [.description] -- The username to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-password]]`link:#quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-password[quarkus.sts.sync-client.crt.proxy.password]` - +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.password`## [.description] -- The password to use when connecting through a proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | -h|[[quarkus-amazon-sts_quarkus-sts-async-client-async-http-transport-configurations]]link:#quarkus-amazon-sts_quarkus-sts-async-client-async-http-transport-configurations[Async HTTP transport configurations] +h|[[quarkus-amazon-sts_section_quarkus-sts-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## h|Type 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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-max-concurrency]] [.property-path]##`quarkus.sts.async-client.max-concurrency`## [.description] -- @@ -1151,18 +1163,18 @@ The maximum number of allowed concurrent requests. For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_MAX_CONCURRENCY+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`50` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sts.async-client.max-pending-connection-acquires`## [.description] -- @@ -1170,18 +1182,18 @@ The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`10000` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-read-timeout]] [.property-path]##`quarkus.sts.async-client.read-timeout`## [.description] -- @@ -1189,19 +1201,18 @@ The amount of time to wait for a read on a socket before an exception is thrown. Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_READ_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_READ_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-write-timeout]] [.property-path]##`quarkus.sts.async-client.write-timeout`## [.description] -- @@ -1209,73 +1220,69 @@ The amount of time to wait for a write on a socket before an exception is thrown Specify `0` to disable. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_WRITE_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`30S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-timeout]] [.property-path]##`quarkus.sts.async-client.connection-timeout`## [.description] -- The amount of time to wait when initially establishing a connection before giving up and timing out. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`10S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-acquisition-timeout]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`2S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-time-to-live]] [.property-path]##`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. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-max-idle-time]] [.property-path]##`quarkus.sts.async-client.connection-max-idle-time`## [.description] -- @@ -1283,19 +1290,18 @@ The maximum amount of time that a connection should be allowed to remain open wh Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5S` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sts.async-client.use-idle-connection-reaper`## [.description] -- @@ -1303,53 +1309,52 @@ Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sts.async-client.tcp-keep-alive`## [.description] -- Configure whether to enable or disable TCP KeepAlive. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-amazon-sts_quarkus-sts-async-client-protocol]]`link:#quarkus-amazon-sts_quarkus-sts-async-client-protocol[quarkus.sts.async-client.protocol]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-protocol]] [.property-path]##`quarkus.sts.async-client.protocol`## [.description] -- The HTTP protocol to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROTOCOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROTOCOL+++` endif::add-copy-button-to-env-var[] --- a| -`http1-1`, `http2` +-- +a|Protocol |`http1-1` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-ssl-provider]] [.property-path]##`quarkus.sts.async-client.ssl-provider`## [.description] -- @@ -1357,19 +1362,18 @@ The SSL Provider to be used in the Netty client. Default is `OPENSSL` if available, `JDK` otherwise. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_SSL_PROVIDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_SSL_PROVIDER+++` endif::add-copy-button-to-env-var[] --- a| -`jdk`, `openssl`, `openssl-refcnt` +-- +a|SslProviderType | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-max-streams]] [.property-path]##`quarkus.sts.async-client.http2.max-streams`## [.description] -- @@ -1377,18 +1381,18 @@ The maximum number of concurrent streams for an HTTP/2 connection. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` endif::add-copy-button-to-env-var[] ---|long +-- +|long |`4294967295` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sts.async-client.http2.initial-window-size`## [.description] -- @@ -1396,18 +1400,18 @@ The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int |`1048576` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-health-check-ping-period]] [.property-path]##`quarkus.sts.async-client.http2.health-check-ping-period`## [.description] -- @@ -1415,36 +1419,35 @@ Sets the period that the Netty client will send `PING` frames to the remote endp This setting is only respected when the HTTP/2 protocol is used. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html[Duration] - link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] |`5` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-enabled]] [.property-path]##`quarkus.sts.async-client.proxy.enabled`## [.description] -- Enable HTTP proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-endpoint]] [.property-path]##`quarkus.sts.async-client.proxy.endpoint`## [.description] -- @@ -1452,36 +1455,35 @@ The endpoint of the proxy server that the SDK should connect through. Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENDPOINT+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/net/URI.html[URI] - +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sts.async-client.proxy.non-proxy-hosts`## [.description] -- The hosts that the client is allowed to access without going through the proxy. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.type`## [.description] -- @@ -1495,36 +1497,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`none`, `system-property`, `file-store` +-- +a|TlsKeyManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.type`## [.description] -- @@ -1532,35 +1533,35 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.type`## [.description] -- @@ -1574,36 +1575,35 @@ Available providers: https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. * `file-store` - Provider that loads the key store from a file. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` endif::add-copy-button-to-env-var[] --- a| -`trust-all`, `system-property`, `file-store` +-- +a|TlsTrustManagersProviderType |`system-property` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.path`## [.description] -- Path to the key store. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` endif::add-copy-button-to-env-var[] ---|path +-- +|path | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.type`## [.description] -- @@ -1611,52 +1611,52 @@ Key store type. See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.password`## [.description] -- Key store password + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-override]] [.property-path]##`quarkus.sts.async-client.event-loop.override`## [.description] -- Enable the custom configuration of the Netty event loop group. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sts.async-client.event-loop.number-of-threads`## [.description] -- @@ -1664,18 +1664,18 @@ Number of threads to use for the event loop group. If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-thread-name-prefix]] [.property-path]##`quarkus.sts.async-client.event-loop.thread-name-prefix`## [.description] -- @@ -1685,18 +1685,18 @@ The prefix will be appended with a number unique to the thread factory and a num If not specified it defaults to `aws-java-sdk-NettyEventLoop` + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a| [[quarkus-amazon-sts_quarkus-sts-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`quarkus.sts.async-client.advanced.use-future-completion-thread-pool`## [.description] -- @@ -1704,19 +1704,23 @@ Whether the default thread pool should be used to complete the futures returned When disabled, futures will be completed on the Netty event loop thread. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` + |=== + ifndef::no-duration-note[] [NOTE] -[id='duration-note-anchor-{summaryTableId}'] +[id=duration-note-anchor-quarkus-amazon-sts_quarkus-sts] .About the Duration format ==== To write duration values, use the standard `java.time.Duration` format. @@ -1733,11 +1737,15 @@ In other cases, the simplified format is translated to the `java.time.Duration` * If the value is a number followed by `d`, it is prefixed with `P`. ==== endif::no-duration-note[] - +ifndef::no-memory-size-note[] [NOTE] -[[memory-size-note-anchor]] +[id=memory-size-note-anchor-quarkus-amazon-sts_quarkus-sts] .About the MemorySize format ==== -A size configuration option recognises string in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + If no suffix is given, assume bytes. ==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-sts_quarkus.sts.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts_quarkus.sts.adoc new file mode 100644 index 000000000..d028967ad --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-sts_quarkus.sts.adoc @@ -0,0 +1,1751 @@ +:summaryTableId: quarkus-amazon-sts_quarkus-sts +[.configuration-legend] +icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime +[.configuration-reference.searchable, cols="80,.^10,.^10"] +|=== + +h|[.header-title]##Configuration property## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-interceptors]] [.property-path]##`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. + +The list should consists of class names which implements `software.amazon.awssdk.core.interceptor.ExecutionInterceptor` interface. Classes will be attempted to be loaded via CDI first, and if no CDI beans are available, then the constructor with no parameters will be invoked to instantiate each class. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-telemetry-enabled]] [.property-path]##`quarkus.sts.telemetry.enabled`## + +[.description] +-- +OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-sync-client-type]] [.property-path]##`quarkus.sts.sync-client.type`## + +[.description] +-- +Type of the sync HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|SyncClientType +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-async-client-type]] [.property-path]##`quarkus.sts.async-client.type`## + +[.description] +-- +Type of the async HTTP client implementation + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AsyncClientType +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-enabled]] [.property-path]##`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 + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-shared]] [.property-path]##`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. + +The discovery uses the `quarkus-dev-service-localstack` label. The value is configured using the `service-name` property. + +Sharing is not supported for the Cognito extension. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-isolated]] [.property-path]##`quarkus.sts.devservices.isolated`## + +[.description] +-- +Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-service-name]] [.property-path]##`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. + +This property is used when you need multiple shared LocalStack instances. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-sts_quarkus-sts-devservices-container-properties-container-properties]] [.property-path]##`quarkus.sts.devservices.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-sts_section_quarkus-sts]] [.section-name.section-level0]##AWS SDK client configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-endpoint-override]] [.property-path]##`quarkus.sts.endpoint-override`## + +`quarkus.sts."client-name".endpoint-override` + +[.description] +-- +The endpoint URI with which the SDK should communicate. + +If not specified, an appropriate endpoint to be used for the given service and region. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ENDPOINT_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sts_quarkus-sts-api-call-timeout]] [.property-path]##`quarkus.sts.api-call-timeout`## + +`quarkus.sts."client-name".api-call-timeout` + +[.description] +-- +The amount of time to allow the client to complete the execution of an API call. + +This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_API_CALL_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sts_quarkus-sts-api-call-attempt-timeout]] [.property-path]##`quarkus.sts.api-call-attempt-timeout`## + +`quarkus.sts."client-name".api-call-attempt-timeout` + +[.description] +-- +The amount of time to wait for the HTTP request to complete before giving up and timing out. + +This value should always be positive, if present. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_API_CALL_ATTEMPT_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sts_quarkus-sts-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##`quarkus.sts.advanced.use-quarkus-scheduled-executor-service`## + +`quarkus.sts."client-name".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_section_quarkus-sts-aws]] [.section-name.section-level0]##AWS services configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-region]] [.property-path]##`quarkus.sts.aws.region`## + +`quarkus.sts."client-name".aws.region` + +[.description] +-- +An Amazon Web Services region that hosts the given service. + +It overrides region provider chain with static value of +region with which the service client should communicate. + +If not set, region is retrieved via the default providers chain in the following order: + +* `aws.region` system property +* `region` property from the profile file +* Instance profile file + +See `software.amazon.awssdk.regions.Region` for available regions. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-type]] [.property-path]##`quarkus.sts.aws.credentials.type`## + +`quarkus.sts."client-name".aws.credentials.type` + +[.description] +-- +Configure the credentials provider that should be used to authenticate with AWS. + +Available values: + +* `default` - the provider will attempt to identify the credentials automatically using the following checks: +** Java System Properties - `aws.accessKeyId` and `aws.secretAccessKey` +** Environment Variables - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` +** Credential profiles file at the default location (`~/.aws/credentials`) shared by all AWS SDKs and the AWS CLI +** Credentials delivered through the Amazon EC2 container service if `AWS_CONTAINER_CREDENTIALS_RELATIVE_URI` environment variable is set and security manager has permission to access the variable. +** Instance profile credentials delivered through the Amazon EC2 metadata service +* `static` - the provider that uses the access key and secret access key specified in the `static-provider` section of the config. +* `system-property` - it loads credentials from the `aws.accessKeyId`, `aws.secretAccessKey` and `aws.sessionToken` system properties. +* `env-variable` - it loads credentials from the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` environment variables. +* `profile` - credentials are based on AWS configuration profiles. This loads credentials from + a http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[profile file], + allowing you to share multiple sets of AWS security credentials between different tools like the AWS SDK for Java and the AWS CLI. +* `container` - It loads credentials from a local metadata service. Containers currently supported by the AWS SDK are + **Amazon Elastic Container Service (ECS)** and **AWS Greengrass** +* `instance-profile` - It loads credentials from the Amazon EC2 Instance Metadata Service. +* `process` - Credentials are loaded from an external process. This is used to support the credential_process setting in the profile + credentials file. See https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#sourcing-credentials-from-external-processes[Sourcing Credentials From External Processes] + for more information. +* `anonymous` - It always returns anonymous AWS credentials. Anonymous AWS credentials result in un-authenticated requests and will + fail unless the resource or API's policy has been configured to specifically allow anonymous access. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|AwsCredentialsProviderType +|`default` + +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-default-provider]] [.section-name.section-level1]##Default credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sts.aws.credentials.default-provider.async-credential-update-enabled`## + +`quarkus.sts."client-name".aws.credentials.default-provider.async-credential-update-enabled` + +[.description] +-- +Whether this provider should fetch credentials asynchronously in the background. + +If this is `true`, threads are less likely to block, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##`quarkus.sts.aws.credentials.default-provider.reuse-last-provider-enabled`## + +`quarkus.sts."client-name".aws.credentials.default-provider.reuse-last-provider-enabled` + +[.description] +-- +Whether the provider should reuse the last successful credentials provider in the chain. + +Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-static-provider]] [.section-name.section-level1]##Static credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-access-key-id]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.access-key-id`## + +`quarkus.sts."client-name".aws.credentials.static-provider.access-key-id` + +[.description] +-- +AWS Access key id + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-secret-access-key]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.secret-access-key`## + +`quarkus.sts."client-name".aws.credentials.static-provider.secret-access-key` + +[.description] +-- +AWS Secret access key + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-static-provider-session-token]] [.property-path]##`quarkus.sts.aws.credentials.static-provider.session-token`## + +`quarkus.sts."client-name".aws.credentials.static-provider.session-token` + +[.description] +-- +AWS Session token + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-profile-provider]] [.section-name.section-level1]##AWS Profile credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-profile-provider-profile-name]] [.property-path]##`quarkus.sts.aws.credentials.profile-provider.profile-name`## + +`quarkus.sts."client-name".aws.credentials.profile-provider.profile-name` + +[.description] +-- +The name of the profile that should be used by this credentials provider. + +If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-process-provider]] [.section-name.section-level1]##Process credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.async-credential-update-enabled`## + +`quarkus.sts."client-name".aws.credentials.process-provider.async-credential-update-enabled` + +[.description] +-- +Whether the provider should fetch credentials asynchronously in the background. + +If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.credential-refresh-threshold`## + +`quarkus.sts."client-name".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. + +This allows the credentials to be refreshed ++*++before++*++ they are reported to expire. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-process-output-limit]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.process-output-limit`## + +`quarkus.sts."client-name".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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-process-provider-command]] [.property-path]##`quarkus.sts.aws.credentials.process-provider.command`## + +`quarkus.sts."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-sts_section_quarkus-sts-aws-credentials-custom-provider]] [.section-name.section-level1]##Custom credentials provider configuration## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-aws-credentials-custom-provider-name]] [.property-path]##`quarkus.sts.aws.credentials.custom-provider.name`## + +`quarkus.sts."client-name".aws.credentials.custom-provider.name` + +[.description] +-- +The name of custom AwsCredentialsProvider bean. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client]] [.section-name.section-level0]##Sync HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-connection-timeout]] [.property-path]##`quarkus.sts.sync-client.connection-timeout`## + +[.description] +-- +The maximum amount of time to establish a connection before timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-socket-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_SOCKET_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.sync-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.sync-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client-apache]] [.section-name.section-level1]##Apache HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-max-idle-time]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-max-connections]] [.property-path]##`quarkus.sts.sync-client.apache.max-connections`## + +[.description] +-- +The maximum number of connections allowed in the connection pool. + +Each built HTTP client has its own private connection pool. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-expect-continue-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.expect-continue-enabled`## + +[.description] +-- +Whether the client should send an HTTP expect-continue handshake before each request. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-use-idle-connection-reaper]] [.property-path]##`quarkus.sts.sync-client.apache.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed asynchronously. + +When enabled, connections left idling for longer than `quarkus..sync-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-tcp-keep-alive]] [.property-path]##`quarkus.sts.sync-client.apache.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-endpoint]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-username]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-password]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-ntlm-domain]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.ntlm-domain`## + +[.description] +-- +For NTLM proxies - the Windows domain name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.ntlm-workstation`## + +[.description] +-- +For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.preemptive-basic-authentication-enabled`## + +[.description] +-- +Whether to attempt to authenticate preemptively against the proxy server using basic authentication. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sts.sync-client.apache.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-sts_section_quarkus-sts-sync-client-crt]] [.section-name.section-level1]##AWS CRT-based HTTP client specific configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-connection-max-idle-time]] [.property-path]##`quarkus.sts.sync-client.crt.connection-max-idle-time`## + +[.description] +-- +The maximum amount of time that a connection should be allowed to remain open while idle. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-max-concurrency]] [.property-path]##`quarkus.sts.sync-client.crt.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-enabled]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-endpoint]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-username]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.username`## + +[.description] +-- +The username to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-sync-client-crt-proxy-password]] [.property-path]##`quarkus.sts.sync-client.crt.proxy.password`## + +[.description] +-- +The password to use when connecting through a proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-sts_section_quarkus-sts-async-client]] [.section-name.section-level0]##Async HTTP transport configurations## +h|Type +h|Default + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-max-concurrency]] [.property-path]##`quarkus.sts.async-client.max-concurrency`## + +[.description] +-- +The maximum number of allowed concurrent requests. + +For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-max-pending-connection-acquires]] [.property-path]##`quarkus.sts.async-client.max-pending-connection-acquires`## + +[.description] +-- +The maximum number of pending acquires allowed. + +Once this exceeds, acquire tries will be failed. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-read-timeout]] [.property-path]##`quarkus.sts.async-client.read-timeout`## + +[.description] +-- +The amount of time to wait for a read on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_READ_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-write-timeout]] [.property-path]##`quarkus.sts.async-client.write-timeout`## + +[.description] +-- +The amount of time to wait for a write on a socket before an exception is thrown. + +Specify `0` to disable. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_WRITE_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-timeout]] [.property-path]##`quarkus.sts.async-client.connection-timeout`## + +[.description] +-- +The amount of time to wait when initially establishing a connection before giving up and timing out. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-acquisition-timeout]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-time-to-live]] [.property-path]##`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. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-connection-max-idle-time]] [.property-path]##`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. + +Currently has no effect if `quarkus..async-client.use-idle-connection-reaper` is false. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-use-idle-connection-reaper]] [.property-path]##`quarkus.sts.async-client.use-idle-connection-reaper`## + +[.description] +-- +Whether the idle connections in the connection pool should be closed. + +When enabled, connections left idling for longer than `quarkus..async-client.connection-max-idle-time` will be closed. This will not close connections currently in use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tcp-keep-alive]] [.property-path]##`quarkus.sts.async-client.tcp-keep-alive`## + +[.description] +-- +Configure whether to enable or disable TCP KeepAlive. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-protocol]] [.property-path]##`quarkus.sts.async-client.protocol`## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|Protocol +|`http1-1` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-ssl-provider]] [.property-path]##`quarkus.sts.async-client.ssl-provider`## + +[.description] +-- +The SSL Provider to be used in the Netty client. + +Default is `OPENSSL` if available, `JDK` otherwise. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|SslProviderType +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-max-streams]] [.property-path]##`quarkus.sts.async-client.http2.max-streams`## + +[.description] +-- +The maximum number of concurrent streams for an HTTP/2 connection. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-initial-window-size]] [.property-path]##`quarkus.sts.async-client.http2.initial-window-size`## + +[.description] +-- +The initial window size for an HTTP/2 stream. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-http2-health-check-ping-period]] [.property-path]##`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. + +This setting is only respected when the HTTP/2 protocol is used. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-enabled]] [.property-path]##`quarkus.sts.async-client.proxy.enabled`## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-endpoint]] [.property-path]##`quarkus.sts.async-client.proxy.endpoint`## + +[.description] +-- +The endpoint of the proxy server that the SDK should connect through. + +Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_ENDPOINT+++` +endif::add-copy-button-to-env-var[] +-- +|link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/URI.html[URI] +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-proxy-non-proxy-hosts]] [.property-path]##`quarkus.sts.async-client.proxy.non-proxy-hosts`## + +[.description] +-- +The hosts that the client is allowed to access without going through the proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-type]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.type`## + +[.description] +-- +TLS key managers provider type. + +Available providers: + +* `none` - Use this provider if you don't want the client to present any certificates to the remote TLS host. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsKeyManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.async-client.tls-key-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-type]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.type`## + +[.description] +-- +TLS trust managers provider type. + +Available providers: + +* `trust-all` - Use this provider to disable the validation of servers certificates and therefore trust all server certificates. +* `system-property` - Provider checks the standard `javax.net.ssl.keyStore`, `javax.net.ssl.keyStorePassword`, and + `javax.net.ssl.keyStoreType` properties defined by the + https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE]. +* `file-store` - Provider that loads the key store from a file. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|TlsTrustManagersProviderType +|`system-property` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.path`## + +[.description] +-- +Path to the key store. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.type`## + +[.description] +-- +Key store type. + +See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html++#++KeyStore++[++Java Cryptography Architecture Standard Algorithm Name Documentation++]++ for information about standard keystore types. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##`quarkus.sts.async-client.tls-trust-managers-provider.file-store.password`## + +[.description] +-- +Key store password + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-override]] [.property-path]##`quarkus.sts.async-client.event-loop.override`## + +[.description] +-- +Enable the custom configuration of the Netty event loop group. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-number-of-threads]] [.property-path]##`quarkus.sts.async-client.event-loop.number-of-threads`## + +[.description] +-- +Number of threads to use for the event loop group. + +If not set, the default Netty thread count is used (which is double the number of available processors unless the `io.netty.eventLoopThreads` system property is set. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-event-loop-thread-name-prefix]] [.property-path]##`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. + +The prefix will be appended with a number unique to the thread factory and a number unique to the thread. + +If not specified it defaults to `aws-java-sdk-NettyEventLoop` + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-sts_quarkus-sts-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##`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. + +When disabled, futures will be completed on the Netty event loop thread. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_STS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_STS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-sts_quarkus-sts] +.About the Duration format +==== +To write duration values, use the standard `java.time.Duration` format. +See the link:https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/time/Duration.html#parse(java.lang.CharSequence)[Duration#parse() Java API documentation] for more information. + +You can also use a simplified format, starting with a number: + +* If the value is only a number, it represents time in seconds. +* If the value is a number followed by `ms`, it represents time in milliseconds. + +In other cases, the simplified format is translated to the `java.time.Duration` format for parsing: + +* If the value is a number followed by `h`, `m`, or `s`, it is prefixed with `PT`. +* If the value is a number followed by `d`, it is prefixed with `P`. +==== +endif::no-duration-note[] +ifndef::no-memory-size-note[] +[NOTE] +[id=memory-size-note-anchor-quarkus-amazon-sts_quarkus-sts] +.About the MemorySize format +==== +A size configuration option recognizes strings in this format (shown as a regular expression): `[0-9]+[KkMmGgTtPpEeZzYy]?`. + +If no suffix is given, assume bytes. +==== +ifndef::no-memory-size-note[] + +:!summaryTableId: \ No newline at end of file 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-amazon_quarkus.aws.adoc similarity index 56% rename from docs/modules/ROOT/pages/includes/quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc rename to docs/modules/ROOT/pages/includes/quarkus-amazon_quarkus.aws.adoc index 9a16eec41..276f28bba 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-amazon_quarkus.aws.adoc @@ -1,137 +1,167 @@ - -:summaryTableId: quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config +:summaryTableId: quarkus-amazon_quarkus-aws [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] +[.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_configuration]]link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type 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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-image-name]] [.property-path]##`quarkus.aws.devservices.localstack.image-name`## [.description] -- The LocalStack container image to use. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_IMAGE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_IMAGE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack/localstack:3.0.1` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-container-properties-container-properties]] [.property-path]##`quarkus.aws.devservices.localstack.container-properties."container-properties"`## + +[.description] +-- +Generic properties that are pass for additional container configuration. -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]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-init-scripts-folder]] [.property-path]##`quarkus.aws.devservices.localstack.init-scripts-folder`## [.description] -- Path to init scripts folder executed during localstack startup. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_SCRIPTS_FOLDER+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_SCRIPTS_FOLDER+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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-classpath]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus-aws-devservices-localstack-init-scripts-classpath[quarkus.aws.devservices.localstack.init-scripts-classpath]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-init-scripts-classpath]] [.property-path]##`quarkus.aws.devservices.localstack.init-scripts-classpath`## [.description] -- Classpath to init scripts folder executed during localstack startup. initScriptsFolder has higher precedence. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_SCRIPTS_CLASSPATH+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_SCRIPTS_CLASSPATH+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-init-completion-msg]] [.property-path]##`quarkus.aws.devservices.localstack.init-completion-msg`## [.description] -- Specific container log message to be waiting for localstack init scripts completion. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_COMPLETION_MSG+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_INIT_COMPLETION_MSG+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string | - -a|icon:lock[title=Fixed at build time] [[quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus-aws-devservices-localstack-port]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus-aws-devservices-localstack-port[quarkus.aws.devservices.localstack.port]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-port]] [.property-path]##`quarkus.aws.devservices.localstack.port`## [.description] -- Optional fixed port localstack will listen to. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_PORT+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_PORT+++` endif::add-copy-button-to-env-var[] ---|int +-- +|int | +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-moto-image-name]] [.property-path]##`quarkus.aws.devservices.moto.image-name`## + +[.description] +-- +The Moto container image to use. + -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."container-properties"]` +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_MOTO_IMAGE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_DEVSERVICES_MOTO_IMAGE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`motoserver/moto` +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-moto-container-properties-container-properties]] [.property-path]##`quarkus.aws.devservices.moto.container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_MOTO_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +Environment variable: `+++QUARKUS_AWS_DEVSERVICES_MOTO_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-additional-services-additional-services-enabled]] [.property-path]##`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 + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean | - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-additional-services-additional-services-shared]] [.property-path]##`quarkus.aws.devservices.localstack.additional-services."additional-services".shared`## [.description] -- @@ -141,35 +171,35 @@ The discovery uses the `quarkus-dev-service-localstack` label. The value is conf Sharing is not supported for the Cognito extension. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__SHARED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__SHARED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -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-isolated]]`link:#quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config_quarkus-aws-devservices-localstack-additional-services-additional-services-isolated[quarkus.aws.devservices.localstack.additional-services."additional-services".isolated]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-additional-services-additional-services-isolated]] [.property-path]##`quarkus.aws.devservices.localstack.additional-services."additional-services".isolated`## [.description] -- Indicates if shared LocalStack services managed by Dev Services should be isolated. When true, the service will be started in its own container and the value of the `quarkus-dev-service-localstack` label will be suffixed by the service name (s3, sqs, ...) + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__ISOLATED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__ISOLATED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`true` - -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]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-additional-services-additional-services-service-name]] [.property-path]##`quarkus.aws.devservices.localstack.additional-services."additional-services".service-name`## [.description] -- @@ -177,31 +207,35 @@ The value of the `quarkus-dev-service-localstack` label attached to the started This property is used when you need multiple shared LocalStack instances. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__SERVICE_NAME+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__SERVICE_NAME+++` endif::add-copy-button-to-env-var[] ---|string +-- +|string |`localstack` - -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."container-properties"]` - +a|icon:lock[title=Fixed at build time] [[quarkus-amazon_quarkus-aws-devservices-localstack-additional-services-additional-services-container-properties-container-properties]] [.property-path]##`quarkus.aws.devservices.localstack.additional-services."additional-services".container-properties."container-properties"`## [.description] -- Generic properties that are pass for additional container configuration. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_AWS_DEVSERVICES_LOCALSTACK_ADDITIONAL_SERVICES__ADDITIONAL_SERVICES__CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - +-- +|Map | -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon_quarkus.otel.adoc similarity index 64% rename from docs/modules/ROOT/pages/includes/quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc rename to docs/modules/ROOT/pages/includes/quarkus-amazon_quarkus.otel.adoc index 6824b5b77..2321cbe7e 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon_quarkus.otel.adoc @@ -1,97 +1,99 @@ - -:summaryTableId: quarkus-otel-instrumentation-aws-sdk-telemetry-config +:summaryTableId: quarkus-amazon_quarkus-otel [.configuration-legend] icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] +[.configuration-reference.searchable, cols="80,.^10,.^10"] |=== -h|[[quarkus-otel-instrumentation-aws-sdk-telemetry-config_configuration]]link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-messaging-experimental-capture-headers]]`link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-messaging-experimental-capture-headers[quarkus.otel.instrumentation.messaging.experimental.capture-headers]` - +a| [[quarkus-amazon_quarkus-otel-instrumentation-messaging-experimental-capture-headers]] [.property-path]##`quarkus.otel.instrumentation.messaging.experimental.capture-headers`## [.description] -- Configures the messaging headers that will be captured as span attributes. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENTATION_MESSAGING_EXPERIMENTAL_CAPTURE_HEADERS+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_INSTRUMENTATION_MESSAGING_EXPERIMENTAL_CAPTURE_HEADERS+++` endif::add-copy-button-to-env-var[] ---|list of string +-- +|list of string | - -a| [[quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-messaging-experimental-receive-telemetry-enabled]]`link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-messaging-experimental-receive-telemetry-enabled[quarkus.otel.instrumentation.messaging.experimental.receive-telemetry.enabled]` - +a| [[quarkus-amazon_quarkus-otel-instrumentation-messaging-experimental-receive-telemetry-enabled]] [.property-path]##`quarkus.otel.instrumentation.messaging.experimental.receive-telemetry.enabled`## [.description] -- Set whether to capture the consumer message receive telemetry in messaging instrumentation. Note that this will cause the consumer side to start a new trace, with only a span link connecting it to the producer trace. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENTATION_MESSAGING_EXPERIMENTAL_RECEIVE_TELEMETRY_ENABLED+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_INSTRUMENTATION_MESSAGING_EXPERIMENTAL_RECEIVE_TELEMETRY_ENABLED+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-span-attributes]]`link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-span-attributes[quarkus.otel.instrumentation.aws-sdk.experimental-span-attributes]` - +a| [[quarkus-amazon_quarkus-otel-instrumentation-aws-sdk-experimental-span-attributes]] [.property-path]##`quarkus.otel.instrumentation.aws-sdk.experimental-span-attributes`## [.description] -- Sets whether experimental attributes should be set to spans. These attributes may be changed or removed in the future, so only enable this if you know you do not require attributes filled by this instrumentation to be stable across versions. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_SPAN_ATTRIBUTES+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_SPAN_ATTRIBUTES+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-use-propagator-for-messaging]]`link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-use-propagator-for-messaging[quarkus.otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging]` - +a| [[quarkus-amazon_quarkus-otel-instrumentation-aws-sdk-experimental-use-propagator-for-messaging]] [.property-path]##`quarkus.otel.instrumentation.aws-sdk.experimental-use-propagator-for-messaging`## [.description] -- Sets whether the io.opentelemetry.context.propagation.TextMapPropagator configured in the provided OpenTelemetry should be used to inject into supported messaging attributes (currently only SQS; SNS may follow). In addition, the X-Ray propagator is always used. Using the messaging propagator is needed if your tracing vendor requires special tracestate entries or legacy propagation information that cannot be transported via X-Ray headers. It may also be useful if you need to directly connect spans over messaging in your tracing backend, bypassing any intermediate spans/X-Ray segments that AWS may create in the delivery process. This option is off by default. If enabled, on extraction the configured propagator will be preferred over X-Ray if it can extract anything. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_USE_PROPAGATOR_FOR_MESSAGING+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_USE_PROPAGATOR_FOR_MESSAGING+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` - -a| [[quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-record-individual-http-error]]`link:#quarkus-otel-instrumentation-aws-sdk-telemetry-config_quarkus-otel-instrumentation-aws-sdk-experimental-record-individual-http-error[quarkus.otel.instrumentation.aws-sdk.experimental-record-individual-http-error]` - +a| [[quarkus-amazon_quarkus-otel-instrumentation-aws-sdk-experimental-record-individual-http-error]] [.property-path]##`quarkus.otel.instrumentation.aws-sdk.experimental-record-individual-http-error`## [.description] -- Sets whether errors returned by each individual HTTP request should be recorded as events for the SDK span. This option is off by default. If enabled, the HTTP error code and the error message will be captured and associated with the span. This provides detailed insights into errors on a per-request basis. + ifdef::add-copy-button-to-env-var[] Environment variable: env_var_with_copy_button:+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_RECORD_INDIVIDUAL_HTTP_ERROR+++[] endif::add-copy-button-to-env-var[] ifndef::add-copy-button-to-env-var[] Environment variable: `+++QUARKUS_OTEL_INSTRUMENTATION_AWS_SDK_EXPERIMENTAL_RECORD_INDIVIDUAL_HTTP_ERROR+++` endif::add-copy-button-to-env-var[] ---|boolean +-- +|boolean |`false` -|=== \ No newline at end of file +|=== + + +:!summaryTableId: \ No newline at end of file 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 deleted file mode 100644 index 7fb396be6..000000000 --- a/docs/modules/ROOT/pages/includes/quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc +++ /dev/null @@ -1,47 +0,0 @@ - -:summaryTableId: quarkus-aws-devservices-moto-moto-dev-services-build-time-config -[.configuration-legend] -icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime -[.configuration-reference, cols="80,.^10,.^10"] -|=== - -h|[[quarkus-aws-devservices-moto-moto-dev-services-build-time-config_configuration]]link:#quarkus-aws-devservices-moto-moto-dev-services-build-time-config_configuration[Configuration property] - -h|Type -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. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_MOTO_IMAGE_NAME+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_AWS_DEVSERVICES_MOTO_IMAGE_NAME+++` -endif::add-copy-button-to-env-var[] ---|string -|`motoserver/moto` - - -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."container-properties"]` - - -[.description] --- -Generic properties that are pass for additional container configuration. - -ifdef::add-copy-button-to-env-var[] -Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_DEVSERVICES_MOTO_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_AWS_DEVSERVICES_MOTO_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` -endif::add-copy-button-to-env-var[] ---|link:https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[String] - -| - -|=== \ No newline at end of file diff --git a/docs/modules/ROOT/pages/opentelemetry.adoc b/docs/modules/ROOT/pages/opentelemetry.adoc index 343121af9..73b2ce3e2 100644 --- a/docs/modules/ROOT/pages/opentelemetry.adoc +++ b/docs/modules/ROOT/pages/opentelemetry.adoc @@ -33,4 +33,4 @@ public class MyProducer { == Configuration Reference -include::./includes/quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc[] +include::./includes/quarkus-amazon_quarkus.otel.adoc[] diff --git a/docs/pom.xml b/docs/pom.xml index cbace313c..1e5542883 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -109,6 +109,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/ROOT/pages/includes/ + + maven-resources-plugin @@ -121,34 +129,6 @@ ${project.basedir}/modules/ROOT/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - - quarkus-aws-devservices-localstack-local-stack-dev-services-build-time-config.adoc - quarkus-aws-devservices-moto-moto-dev-services-build-time-config.adoc - quarkus-otel-instrumentation-aws-sdk-telemetry-config.adoc - quarkus-amazon-cloudwatch.adoc - quarkus-amazon-cloudwatchlogs.adoc - quarkus-amazon-cognitouserpools.adoc - quarkus-amazon-dynamodb.adoc - quarkus-amazon-dynamodb-enhanced.adoc - quarkus-amazon-ecr.adoc - quarkus-amazon-eventbridge.adoc - quarkus-amazon-iam.adoc - quarkus-amazon-kms.adoc - quarkus-amazon-kinesis.adoc - quarkus-amazon-lambda.adoc - quarkus-amazon-s3.adoc - quarkus-amazon-secretsmanager.adoc - quarkus-amazon-ses.adoc - quarkus-amazon-sfn.adoc - quarkus-amazon-sns.adoc - quarkus-amazon-sqs.adoc - quarkus-amazon-ssm.adoc - quarkus-amazon-sts.adoc - - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedDbTableProcessor.java b/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedDbTableProcessor.java index 13fe0cf24..d23f83eea 100644 --- a/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedDbTableProcessor.java +++ b/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedDbTableProcessor.java @@ -5,7 +5,6 @@ import java.util.HashSet; import java.util.List; import java.util.Map; -import java.util.Optional; import java.util.Set; import jakarta.enterprise.inject.spi.DeploymentException; @@ -20,7 +19,8 @@ import org.jboss.jandex.IndexView; import org.jboss.jandex.ParameterizedType; -import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.runtime.ClientUtil; import io.quarkus.amazon.dynamodb.enhanced.runtime.NamedDynamoDbTable; import io.quarkus.arc.SyntheticCreationalContext; import io.quarkus.arc.deployment.AdditionalBeanBuildItem; @@ -59,16 +59,12 @@ public class DynamodbEnhancedDbTableProcessor { @BuildStep AdditionalBeanBuildItem additionalBeans() { - return AdditionalBeanBuildItem.unremovableOf(NamedDynamoDbTable.class); + return new AdditionalBeanBuildItem(NamedDynamoDbTable.class); } @BuildStep void discoverDynamoDbTable(CombinedIndexBuildItem combinedIndexBuildItem, - BuildProducer tables, - BuildProducer requireClientProducer) { - - Optional syncClassName = Optional.empty(); - Optional asyncClassName = Optional.empty(); + BuildProducer tables) { Set> asyncSeen = new HashSet<>(); Set> syncSeen = new HashSet<>(); @@ -93,7 +89,6 @@ void discoverDynamoDbTable(CombinedIndexBuildItem combinedIndexBuildItem, tables.produce(new DynamodbEnhancedTableBuildItem(tableName, beanClassName, DotNames.DYNAMODB_ENHANCED_CLIENT, DYNAMODB_ENHANCED_CLIENT_TABLE_METHOD, DotNames.DYNAMODB_TABLE)); - syncClassName = Optional.of(DotNames.DYNAMODB_CLIENT); } } if (DotNames.DYNAMODB_ASYNC_TABLE.equals(field.type().name())) { @@ -101,23 +96,38 @@ void discoverDynamoDbTable(CombinedIndexBuildItem combinedIndexBuildItem, tables.produce(new DynamodbEnhancedTableBuildItem(tableName, beanClassName, DotNames.DYNAMODB_ENHANCED_ASYNC_CLIENT, DYNAMODB_ENHANCED_ASYNC_CLIENT_TABLE_METHOD, DotNames.DYNAMODB_ASYNC_TABLE)); - asyncClassName = Optional.of(DotNames.DYNAMODB_ASYNC_CLIENT); } } } } - - if (syncClassName.isPresent() || asyncClassName.isPresent()) { - requireClientProducer.produce(new RequireAmazonClientBuildItem(syncClassName, asyncClassName)); - } } @BuildStep public void produceNamedDbTableBean(List tables, + BuildProducer requireClientInjectionProducer, BuildProducer syntheticBean) { + // produce a synthetic bean for each DynamoDb table bean tables.stream().map(DynamodbEnhancedDbTableProcessor::generateDynamoDbTableSyntheticBean) .forEach(syntheticBean::produce); + // each table bean requires a DynamoDb Enhanced client + tables.stream() + .map(table -> new RequireAmazonClientInjectionBuildItem(table.getClientClassName(), + ClientUtil.DEFAULT_CLIENT_NAME)) + .forEach(requireClientInjectionProducer::produce); + // which in turn require a regular low-level DynamoDb client + tables.stream() + .map(table -> new RequireAmazonClientInjectionBuildItem(getLowLevelClientClassName(table.getClientClassName()), + ClientUtil.DEFAULT_CLIENT_NAME)) + .forEach(requireClientInjectionProducer::produce); + } + + public DotName getLowLevelClientClassName(DotName enhancedClientClassName) { + if (DotNames.DYNAMODB_ENHANCED_CLIENT.equals(enhancedClientClassName)) { + return DotNames.DYNAMODB_CLIENT; + } else { + return DotNames.DYNAMODB_ASYNC_CLIENT; + } } static private SyntheticBeanBuildItem generateDynamoDbTableSyntheticBean(DynamodbEnhancedTableBuildItem table) { diff --git a/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedProcessor.java b/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedProcessor.java index ec83fe878..5aeb2f7e6 100644 --- a/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedProcessor.java +++ b/dynamodb-enhanced/deployment/src/main/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamodbEnhancedProcessor.java @@ -1,5 +1,9 @@ package io.quarkus.amazon.dynamodb.enhanced.deployment; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.getNamedClientInjection; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.injectionPointAnnotationsClient; +import static io.quarkus.amazon.common.deployment.ClientDeploymentUtil.namedClient; + import java.util.ArrayList; import java.util.List; import java.util.Optional; @@ -22,7 +26,7 @@ import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; -import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; import io.quarkus.amazon.dynamodb.enhanced.runtime.BeanTableSchemaSubstitutionImplementation; import io.quarkus.amazon.dynamodb.enhanced.runtime.DynamoDbEnhancedBuildTimeConfig; import io.quarkus.amazon.dynamodb.enhanced.runtime.DynamodbEnhancedClientRecorder; @@ -68,10 +72,7 @@ FeatureBuildItem feature() { void setup(CombinedIndexBuildItem combinedIndexBuildItem, DynamoDbEnhancedBuildTimeConfig buildTimeConfig, BeanRegistrationPhaseBuildItem beanRegistrationPhase, - BuildProducer requireClientProducer) { - - Optional syncClassName = Optional.empty(); - Optional asyncClassName = Optional.empty(); + BuildProducer requireClientInjectionProducer) { // Discover all known dynamodb-enhanced-client-extension implementors List knownDynamodbEnhancedClientExtensionImpls = combinedIndexBuildItem.getIndex() @@ -97,16 +98,14 @@ void setup(CombinedIndexBuildItem combinedIndexBuildItem, org.jboss.jandex.Type injectedType = injectionPoint.getRequiredType(); if (DotNames.DYNAMODB_ENHANCED_CLIENT.equals(injectedType.name())) { - syncClassName = Optional.of(DotNames.DYNAMODB_CLIENT); + requireClientInjectionProducer.produce(new RequireAmazonClientInjectionBuildItem( + DotNames.DYNAMODB_CLIENT, getNamedClientInjection(injectionPoint))); } if (DotNames.DYNAMODB_ENHANCED_ASYNC_CLIENT.equals(injectedType.name())) { - asyncClassName = Optional.of(DotNames.DYNAMODB_ASYNC_CLIENT); + requireClientInjectionProducer.produce(new RequireAmazonClientInjectionBuildItem( + DotNames.DYNAMODB_ASYNC_CLIENT, getNamedClientInjection(injectionPoint))); } } - - if (syncClassName.isPresent() || asyncClassName.isPresent()) { - requireClientProducer.produce(new RequireAmazonClientBuildItem(syncClassName, asyncClassName)); - } } @BuildStep @@ -119,36 +118,44 @@ void createClientBuilders( String configName = "dynamodb"; - Optional syncClientRuntime = syncBuilder.stream() + // we cannot filter by requirement origin, so we may create enhanced builder for standard client requirements + List syncClientRuntime = syncBuilder.stream() .filter(c -> configName.equals(c.getAwsClientName())) - .findFirst(); - Optional asyncClientRuntime = asyncBuilder.stream() + .collect(Collectors.toList()); + List asyncClientRuntime = asyncBuilder.stream() .filter(c -> configName.equals(c.getAwsClientName())) - .findFirst(); + .collect(Collectors.toList()); - if (syncClientRuntime.isPresent() || asyncClientRuntime.isPresent()) { + if (!syncClientRuntime.isEmpty() || !asyncClientRuntime.isEmpty()) { RuntimeValue extensions = recorder.createExtensionList(); - if (syncClientRuntime.isPresent()) { - syntheticBean.produce(SyntheticBeanBuildItem - .configure(DynamoDbEnhancedClient.class) + for (AmazonClientSyncResultBuildItem amazonClientSyncResultBuildItem : syncClientRuntime) { + + syntheticBean.produce(namedClient(SyntheticBeanBuildItem + .configure(DynamoDbEnhancedClient.class), amazonClientSyncResultBuildItem.getClientName()) .unremovable() .defaultBean() .scope(ApplicationScoped.class) .setRuntimeInit() - .createWith(recorder.createDynamoDbEnhancedClient(extensions)) - .addInjectionPoint(ClassType.create(DynamoDbClient.class)).done()); + .createWith(recorder.createDynamoDbEnhancedClient(extensions, + amazonClientSyncResultBuildItem.getClientName())) + .addInjectionPoint(ClassType.create(DynamoDbClient.class), + injectionPointAnnotationsClient(amazonClientSyncResultBuildItem.getClientName())) + .done()); } - if (asyncClientRuntime.isPresent()) { - syntheticBean.produce(SyntheticBeanBuildItem - .configure(DynamoDbEnhancedAsyncClient.class) + for (AmazonClientAsyncResultBuildItem amazonClientAsyncResultBuildItem : asyncClientRuntime) { + syntheticBean.produce(namedClient(SyntheticBeanBuildItem + .configure(DynamoDbEnhancedAsyncClient.class), amazonClientAsyncResultBuildItem.getClientName()) .unremovable() .defaultBean() .scope(ApplicationScoped.class) .setRuntimeInit() - .createWith(recorder.createDynamoDbEnhancedAsyncClient(extensions)) - .addInjectionPoint(ClassType.create(DynamoDbAsyncClient.class)).done()); + .createWith(recorder.createDynamoDbEnhancedAsyncClient(extensions, + amazonClientAsyncResultBuildItem.getClientName())) + .addInjectionPoint(ClassType.create(DynamoDbAsyncClient.class), + injectionPointAnnotationsClient(amazonClientAsyncResultBuildItem.getClientName())) + .done()); } } } diff --git a/dynamodb-enhanced/deployment/src/test/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamoDbEnhancedClientTest.java b/dynamodb-enhanced/deployment/src/test/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamoDbEnhancedClientTest.java new file mode 100644 index 000000000..79854b08d --- /dev/null +++ b/dynamodb-enhanced/deployment/src/test/java/io/quarkus/amazon/dynamodb/enhanced/deployment/DynamoDbEnhancedClientTest.java @@ -0,0 +1,42 @@ +package io.quarkus.amazon.dynamodb.enhanced.deployment; + +import jakarta.inject.Inject; + +import org.junit.Assert; +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import io.quarkus.amazon.common.AmazonClient; +import io.quarkus.arc.ClientProxy; +import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient; + +public class DynamoDbEnhancedClientTest { + + @Inject + DynamoDbEnhancedClient client; + + @Inject + DynamoDbEnhancedClient clientSame; + + @Inject + @AmazonClient("test") + DynamoDbEnhancedClient clientNamedTest; + + @Inject + @AmazonClient("test") + DynamoDbEnhancedClient clientNamedTestSame; + + @RegisterExtension + static final QuarkusUnitTest config = new QuarkusUnitTest() + .withApplicationRoot((jar) -> jar + .addClass(DynamoDbEnhancedClientProducer.class) + .addAsResource("full-config.properties", "application.properties")); + + @Test + public void test() { + Assert.assertNotEquals(ClientProxy.unwrap(clientNamedTest), ClientProxy.unwrap(client)); + Assert.assertEquals(ClientProxy.unwrap(clientSame), ClientProxy.unwrap(client)); + Assert.assertEquals(ClientProxy.unwrap(clientNamedTestSame), ClientProxy.unwrap(clientNamedTest)); + } +} diff --git a/dynamodb-enhanced/runtime/src/main/java/io/quarkus/amazon/dynamodb/enhanced/runtime/DynamodbEnhancedClientRecorder.java b/dynamodb-enhanced/runtime/src/main/java/io/quarkus/amazon/dynamodb/enhanced/runtime/DynamodbEnhancedClientRecorder.java index fccc98f87..19ee779b8 100644 --- a/dynamodb-enhanced/runtime/src/main/java/io/quarkus/amazon/dynamodb/enhanced/runtime/DynamodbEnhancedClientRecorder.java +++ b/dynamodb-enhanced/runtime/src/main/java/io/quarkus/amazon/dynamodb/enhanced/runtime/DynamodbEnhancedClientRecorder.java @@ -11,6 +11,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; +import io.quarkus.amazon.common.runtime.ClientUtil; import io.quarkus.arc.SyntheticCreationalContext; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -78,23 +79,37 @@ private DynamoDbEnhancedClientExtension createExtension(String extensionClassNam } public Function, DynamoDbEnhancedClient> createDynamoDbEnhancedClient( - RuntimeValue extensions) { + RuntimeValue extensions, String clientName) { return new Function, DynamoDbEnhancedClient>() { @Override public DynamoDbEnhancedClient apply(SyntheticCreationalContext context) { - return DynamoDbEnhancedClient.builder().dynamoDbClient(context.getInjectedReference(DynamoDbClient.class)) + DynamoDbClient client; + if (ClientUtil.isDefaultClient(clientName)) + client = context.getInjectedReference(DynamoDbClient.class); + else + client = context.getInjectedReference(DynamoDbClient.class, + new io.quarkus.amazon.common.AmazonClient.AmazonClientLiteral(clientName)); + + return DynamoDbEnhancedClient.builder().dynamoDbClient(client) .extensions(extensions.getValue()).build(); } }; } public Function, DynamoDbEnhancedAsyncClient> createDynamoDbEnhancedAsyncClient( - RuntimeValue extensions) { + RuntimeValue extensions, String clientName) { return new Function, DynamoDbEnhancedAsyncClient>() { @Override public DynamoDbEnhancedAsyncClient apply(SyntheticCreationalContext context) { + DynamoDbAsyncClient client; + if (ClientUtil.isDefaultClient(clientName)) + client = context.getInjectedReference(DynamoDbAsyncClient.class); + else + client = context.getInjectedReference(DynamoDbAsyncClient.class, + new io.quarkus.amazon.common.AmazonClient.AmazonClientLiteral(clientName)); + return DynamoDbEnhancedAsyncClient.builder() - .dynamoDbClient(context.getInjectedReference(DynamoDbAsyncClient.class)) + .dynamoDbClient(client) .extensions(extensions.getValue()).build(); } }; diff --git a/dynamodb/deployment/src/main/java/io/quarkus/amazon/dynamodb/deployment/DynamodbProcessor.java b/dynamodb/deployment/src/main/java/io/quarkus/amazon/dynamodb/deployment/DynamodbProcessor.java index 45259ff4f..33b3a55eb 100644 --- a/dynamodb/deployment/src/main/java/io/quarkus/amazon/dynamodb/deployment/DynamodbProcessor.java +++ b/dynamodb/deployment/src/main/java/io/quarkus/amazon/dynamodb/deployment/DynamodbProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -88,10 +89,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -102,7 +111,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -110,7 +119,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, DynamodbRecorder recorder, + void setupApacheSyncTransport(List amazonClients, DynamodbRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -123,7 +132,7 @@ void setupApacheSyncTransport(List amazonClients, Dynamod @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, DynamodbRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, DynamodbRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -136,7 +145,8 @@ void setupAwsCrtSyncTransport(List amazonClients, Dynamod @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, DynamodbRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + DynamodbRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -149,7 +159,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, DynamodbRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, DynamodbRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -163,7 +173,7 @@ void setupNettyAsyncTransport(List amazonClients, Dynamod @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, DynamodbRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, DynamodbRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -179,6 +189,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Dynamo void createClientBuilders(DynamodbRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -193,6 +204,7 @@ void createClientBuilders(DynamodbRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbConfig.java b/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbConfig.java index 1d57858b8..77f1dc345 100644 --- a/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbConfig.java +++ b/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbConfig.java @@ -1,38 +1,17 @@ package io.quarkus.amazon.dynamodb.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; import io.smallrye.config.WithDefault; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.dynamodb") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface DynamodbConfig { - /** - * Enable DynamoDB service endpoint discovery. - */ - @WithDefault("false") - boolean enableEndpointDiscovery(); - - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface DynamodbConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ @@ -44,4 +23,10 @@ public interface DynamodbConfig { */ @ConfigDocSection AsyncHttpClientConfig asyncClient(); + + /** + * Enable DynamoDB service endpoint discovery. + */ + @WithDefault("false") + boolean enableEndpointDiscovery(); } diff --git a/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbRecorder.java b/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbRecorder.java index 241bb32c1..64334b0be 100644 --- a/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbRecorder.java +++ b/dynamodb/runtime/src/main/java/io/quarkus/amazon/dynamodb/runtime/DynamodbRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public DynamodbRecorder(DynamodbConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/ecr/deployment/src/main/java/io/quarkus/amazon/ecr/deployment/EcrProcessor.java b/ecr/deployment/src/main/java/io/quarkus/amazon/ecr/deployment/EcrProcessor.java index 263bf60a0..fe4f2ef58 100644 --- a/ecr/deployment/src/main/java/io/quarkus/amazon/ecr/deployment/EcrProcessor.java +++ b/ecr/deployment/src/main/java/io/quarkus/amazon/ecr/deployment/EcrProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, EcrRecorder recorder, + void setupApacheSyncTransport(List amazonClients, EcrRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, EcrReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, EcrRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, EcrRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, EcrReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, EcrRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, EcrRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, EcrRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, EcrRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, EcrReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, EcrRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, EcrRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, EcrRec void createClientBuilders(EcrRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(EcrRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrConfig.java b/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrConfig.java index 9bc2616ab..a8df340c7 100644 --- a/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrConfig.java +++ b/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.ecr.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.ecr") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface EcrConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface EcrConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrRecorder.java b/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrRecorder.java index c8b4c789a..3fc23cfa5 100644 --- a/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrRecorder.java +++ b/ecr/runtime/src/main/java/io/quarkus/amazon/ecr/runtime/EcrRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public EcrRecorder(EcrConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/eventbridge/deployment/src/main/java/io/quarkus/amazon/eventbridge/deployment/EventBridgeProcessor.java b/eventbridge/deployment/src/main/java/io/quarkus/amazon/eventbridge/deployment/EventBridgeProcessor.java index 4fbbb5076..29a4411bc 100644 --- a/eventbridge/deployment/src/main/java/io/quarkus/amazon/eventbridge/deployment/EventBridgeProcessor.java +++ b/eventbridge/deployment/src/main/java/io/quarkus/amazon/eventbridge/deployment/EventBridgeProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,8 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, EventBridgeRecorder recorder, + void setupApacheSyncTransport(List amazonClients, + EventBridgeRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +124,8 @@ void setupApacheSyncTransport(List amazonClients, EventBr @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, EventBridgeRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, + EventBridgeRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +138,8 @@ void setupAwsCrtSyncTransport(List amazonClients, EventBr @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, EventBridgeRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + EventBridgeRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +152,8 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, EventBridgeRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, + EventBridgeRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +167,8 @@ void setupNettyAsyncTransport(List amazonClients, EventBr @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, EventBridgeRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + EventBridgeRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +184,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, EventB void createClientBuilders(EventBridgeRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +199,7 @@ void createClientBuilders(EventBridgeRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeConfig.java b/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeConfig.java index be2a96f83..9583503e7 100644 --- a/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeConfig.java +++ b/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.eventbridge.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigRoot(phase = ConfigPhase.RUN_TIME) @ConfigMapping(prefix = "quarkus.eventbridge") -public interface EventBridgeConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface EventBridgeConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeRecorder.java b/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeRecorder.java index dc2b7b70c..9532b1ab1 100644 --- a/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeRecorder.java +++ b/eventbridge/runtime/src/main/java/io/quarkus/amazon/eventbridge/runtime/EventBridgeRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public EventBridgeRecorder(EventBridgeConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/iam/deployment/src/main/java/io/quarkus/amazon/iam/deployment/IamProcessor.java b/iam/deployment/src/main/java/io/quarkus/amazon/iam/deployment/IamProcessor.java index ef7bd1401..9d5dba566 100644 --- a/iam/deployment/src/main/java/io/quarkus/amazon/iam/deployment/IamProcessor.java +++ b/iam/deployment/src/main/java/io/quarkus/amazon/iam/deployment/IamProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, IamRecorder recorder, + void setupApacheSyncTransport(List amazonClients, IamRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, IamReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, IamRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, IamRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, IamReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, IamRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, IamRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, IamRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, IamRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, IamReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, IamRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, IamRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, IamRec void createClientBuilders(IamRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(IamRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamConfig.java b/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamConfig.java index 6b8fa8fd2..5649e1b3a 100644 --- a/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamConfig.java +++ b/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.iam.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.iam") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface IamConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface IamConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamRecorder.java b/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamRecorder.java index 54d68e24d..fc50c73db 100644 --- a/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamRecorder.java +++ b/iam/runtime/src/main/java/io/quarkus/amazon/iam/runtime/IamRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public IamRecorder(IamConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/inspector/deployment/src/main/java/io/quarkus/amazon/inspector/deployment/InspectorProcessor.java b/inspector/deployment/src/main/java/io/quarkus/amazon/inspector/deployment/InspectorProcessor.java index 7cf2b70b2..2bfc1ee4b 100644 --- a/inspector/deployment/src/main/java/io/quarkus/amazon/inspector/deployment/InspectorProcessor.java +++ b/inspector/deployment/src/main/java/io/quarkus/amazon/inspector/deployment/InspectorProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, InspectorRecorder recorder, + void setupApacheSyncTransport(List amazonClients, InspectorRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, InspectorRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, InspectorRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,8 @@ void setupAwsCrtSyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, InspectorRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + InspectorRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +150,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, InspectorRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, InspectorRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +164,7 @@ void setupNettyAsyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, InspectorRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, InspectorRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +180,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Inspec void createClientBuilders(InspectorRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +195,7 @@ void createClientBuilders(InspectorRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorConfig.java b/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorConfig.java index 442620ac7..47b64ce6d 100644 --- a/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorConfig.java +++ b/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.inspector.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.inspector") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface InspectorConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface InspectorConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorRecorder.java b/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorRecorder.java index 504852f4e..b5bf7b509 100644 --- a/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorRecorder.java +++ b/inspector/runtime/src/main/java/io/quarkus/amazon/inspector/runtime/InspectorRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public InspectorRecorder(InspectorConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/inspector2/deployment/src/main/java/io/quarkus/amazon/inspector2/deployment/Inspector2Processor.java b/inspector2/deployment/src/main/java/io/quarkus/amazon/inspector2/deployment/Inspector2Processor.java index 139e31b28..391aea689 100644 --- a/inspector2/deployment/src/main/java/io/quarkus/amazon/inspector2/deployment/Inspector2Processor.java +++ b/inspector2/deployment/src/main/java/io/quarkus/amazon/inspector2/deployment/Inspector2Processor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, Inspector2Recorder recorder, + void setupApacheSyncTransport(List amazonClients, Inspector2Recorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, Inspector2Recorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, Inspector2Recorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,8 @@ void setupAwsCrtSyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, Inspector2Recorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + Inspector2Recorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +150,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, Inspector2Recorder recorder, + void setupNettyAsyncTransport(List amazonClients, Inspector2Recorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +164,8 @@ void setupNettyAsyncTransport(List amazonClients, Inspect @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, Inspector2Recorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + Inspector2Recorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +181,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Inspec void createClientBuilders(Inspector2Recorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +196,7 @@ void createClientBuilders(Inspector2Recorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Config.java b/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Config.java index 961936daf..753f7194c 100644 --- a/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Config.java +++ b/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Config.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.inspector2.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.inspector2") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface Inspector2Config { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface Inspector2Config extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Recorder.java b/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Recorder.java index 7cb024681..6b5d98936 100644 --- a/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Recorder.java +++ b/inspector2/runtime/src/main/java/io/quarkus/amazon/inspector2/runtime/Inspector2Recorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public Inspector2Recorder(Inspector2Config config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/integration-tests/src/main/java/io/quarkus/it/amazon/iam/IamResource.java b/integration-tests/src/main/java/io/quarkus/it/amazon/iam/IamResource.java index 2748ecb35..b78820665 100644 --- a/integration-tests/src/main/java/io/quarkus/it/amazon/iam/IamResource.java +++ b/integration-tests/src/main/java/io/quarkus/it/amazon/iam/IamResource.java @@ -12,10 +12,12 @@ import org.jboss.logging.Logger; +import io.quarkus.amazon.common.AmazonClient; import software.amazon.awssdk.services.iam.IamAsyncClient; import software.amazon.awssdk.services.iam.IamClient; import software.amazon.awssdk.services.iam.model.CreateUserRequest; import software.amazon.awssdk.services.iam.model.CreateUserResponse; +import software.amazon.awssdk.services.iam.model.GetUserResponse; @Path("/iam") public class IamResource { @@ -28,6 +30,10 @@ public class IamResource { @Inject IamAsyncClient iamAsyncClient; + @Inject + @AmazonClient("custom") + IamClient iamClientNamedCustom; + @GET @Path("sync") @Produces(TEXT_PLAIN) @@ -49,4 +55,16 @@ public String testAsync() throws InterruptedException, ExecutionException { return String.valueOf(user.get().sdkHttpResponse().statusCode()); } + + @GET + @Path("account") + @Produces(TEXT_PLAIN) + public String testCustomSync() throws InterruptedException, ExecutionException { + LOG.info("Testing Named Sync IAM client"); + + GetUserResponse user = iamClient.getUser(); + GetUserResponse userNamed = iamClientNamedCustom.getUser(); + + return user.user().userId() + ":" + userNamed.user().userId(); + } } diff --git a/integration-tests/src/main/java/io/quarkus/it/amazon/kinesis/KinesisResource.java b/integration-tests/src/main/java/io/quarkus/it/amazon/kinesis/KinesisResource.java index 89efdf455..a2d70a95d 100644 --- a/integration-tests/src/main/java/io/quarkus/it/amazon/kinesis/KinesisResource.java +++ b/integration-tests/src/main/java/io/quarkus/it/amazon/kinesis/KinesisResource.java @@ -5,6 +5,7 @@ import java.util.concurrent.CompletableFuture; import java.util.concurrent.CompletionStage; +import jakarta.enterprise.inject.CreationException; import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; @@ -37,7 +38,7 @@ public String testSync() { kinesisClient.createStream(builder -> builder.streamName(STREAM_NAME + "sync").shardCount(1)); return kinesisClient.describeStream(builder -> builder.streamName(STREAM_NAME + "sync")).streamDescription() .streamARN(); - } catch (UnsupportedOperationException ex) { + } catch (CreationException ex) { return ex.getMessage(); } } @@ -53,7 +54,7 @@ public CompletionStage testAsync() { .thenCompose( discard -> kinesisAsyncClient.describeStream(builder -> builder.streamName(STREAM_NAME + "async")) .thenApply(r -> r.streamDescription().streamARN())); - } catch (UnsupportedOperationException ex) { + } catch (CreationException ex) { return CompletableFuture.completedStage(ex.getMessage()); } } diff --git a/integration-tests/src/main/java/io/quarkus/it/amazon/s3/S3Resource.java b/integration-tests/src/main/java/io/quarkus/it/amazon/s3/S3Resource.java index f63272869..1845923c7 100644 --- a/integration-tests/src/main/java/io/quarkus/it/amazon/s3/S3Resource.java +++ b/integration-tests/src/main/java/io/quarkus/it/amazon/s3/S3Resource.java @@ -17,6 +17,7 @@ import org.jboss.logging.Logger; +import io.quarkus.amazon.common.AmazonClient; import io.quarkus.amazon.common.runtime.AsyncHttpClientBuildTimeConfig.AsyncClientType; import io.quarkus.amazon.s3.runtime.S3BuildTimeConfig; import io.quarkus.amazon.s3.runtime.S3Crt; @@ -46,6 +47,7 @@ public class S3Resource { S3Client s3Client; @Inject + @AmazonClient("custom") S3AsyncClient s3AsyncClient; @Inject diff --git a/integration-tests/src/main/java/io/quarkus/it/amazon/s3transfermanager/S3TransferManagerResource.java b/integration-tests/src/main/java/io/quarkus/it/amazon/s3transfermanager/S3TransferManagerResource.java index abd4093e0..c5b8a788c 100644 --- a/integration-tests/src/main/java/io/quarkus/it/amazon/s3transfermanager/S3TransferManagerResource.java +++ b/integration-tests/src/main/java/io/quarkus/it/amazon/s3transfermanager/S3TransferManagerResource.java @@ -102,9 +102,10 @@ public CompletionStage testCrtAsyncS3() { return "ERROR"; }); } catch (UnsatisfiedResolutionException ex) { - if (s3Config.asyncClient().type().equals(AsyncClientType.AWS_CRT)) + if (s3Config.asyncClient().type().equals(AsyncClientType.AWS_CRT)) { + LOG.error("Error during async S3 operations", ex); return CompletableFuture.completedStage("ERROR"); - else + } else return CompletableFuture.completedStage(ex.getMessage()); } } diff --git a/integration-tests/src/main/resources/application.properties b/integration-tests/src/main/resources/application.properties index 6aea8ba9e..d008aa1e3 100644 --- a/integration-tests/src/main/resources/application.properties +++ b/integration-tests/src/main/resources/application.properties @@ -46,4 +46,8 @@ quarkus.sqs.async-client.type=${async-client.type} quarkus.ssm.async-client.type=${async-client.type} quarkus.sts.async-client.type=${async-client.type} -quarkus.s3.telemetry.enabled=true \ No newline at end of file +quarkus.s3.telemetry.enabled=true + +quarkus.iam.custom.aws.credentials.type=static +quarkus.iam.custom.aws.credentials.static-provider.access-key-id=112233445566 +quarkus.iam.custom.aws.credentials.static-provider.secret-access-key=test diff --git a/integration-tests/src/test/java/io/quarkus/it/amazon/AmazonIamTest.java b/integration-tests/src/test/java/io/quarkus/it/amazon/AmazonIamTest.java index 172d716c4..84be86ca0 100644 --- a/integration-tests/src/test/java/io/quarkus/it/amazon/AmazonIamTest.java +++ b/integration-tests/src/test/java/io/quarkus/it/amazon/AmazonIamTest.java @@ -1,6 +1,7 @@ package io.quarkus.it.amazon; import static org.hamcrest.Matchers.any; +import static org.hamcrest.Matchers.equalTo; import org.junit.jupiter.api.Test; @@ -11,12 +12,17 @@ public class AmazonIamTest { @Test - public void testSesAsync() { + public void testIamAsync() { RestAssured.when().get("/test/iam/async").then().body(any(String.class)); } @Test - public void testSesSync() { + public void testIamSync() { RestAssured.when().get("/test/iam/sync").then().body(any(String.class)); } + + @Test + public void testAccountSync() { + RestAssured.when().get("/test/iam/account").then().body(equalTo("000000000000:112233445566")); + } } diff --git a/kinesis/deployment/src/main/java/io/quarkus/amazon/kinesis/deployment/KinesisProcessor.java b/kinesis/deployment/src/main/java/io/quarkus/amazon/kinesis/deployment/KinesisProcessor.java index 29c8e2ff1..2e898ca1c 100644 --- a/kinesis/deployment/src/main/java/io/quarkus/amazon/kinesis/deployment/KinesisProcessor.java +++ b/kinesis/deployment/src/main/java/io/quarkus/amazon/kinesis/deployment/KinesisProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, KinesisRecorder recorder, + void setupApacheSyncTransport(List amazonClients, KinesisRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, Kinesis @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, KinesisRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, KinesisRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,8 @@ void setupAwsCrtSyncTransport(List amazonClients, Kinesis @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, KinesisRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + KinesisRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +150,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, KinesisRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, KinesisRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +164,7 @@ void setupNettyAsyncTransport(List amazonClients, Kinesis @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, KinesisRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, KinesisRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +180,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Kinesi void createClientBuilders(KinesisRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +195,7 @@ void createClientBuilders(KinesisRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisConfig.java b/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisConfig.java index ce3a8a08b..a34dc5d00 100644 --- a/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisConfig.java +++ b/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.kinesis.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigRoot(phase = ConfigPhase.RUN_TIME) @ConfigMapping(prefix = "quarkus.kinesis") -public interface KinesisConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface KinesisConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisRecorder.java b/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisRecorder.java index 7e54ac5e3..71234cbc7 100644 --- a/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisRecorder.java +++ b/kinesis/runtime/src/main/java/io/quarkus/amazon/kinesis/runtime/KinesisRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public KinesisRecorder(KinesisConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/kms/deployment/src/main/java/io/quarkus/amazon/kms/deployment/KmsProcessor.java b/kms/deployment/src/main/java/io/quarkus/amazon/kms/deployment/KmsProcessor.java index 0df4713ad..43da9f084 100644 --- a/kms/deployment/src/main/java/io/quarkus/amazon/kms/deployment/KmsProcessor.java +++ b/kms/deployment/src/main/java/io/quarkus/amazon/kms/deployment/KmsProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, KmsRecorder recorder, + void setupApacheSyncTransport(List amazonClients, KmsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, KmsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, KmsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, KmsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, KmsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, KmsRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, KmsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, KmsRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, KmsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, KmsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, KmsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, KmsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, KmsRec void createClientBuilders(KmsRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(KmsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsConfig.java b/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsConfig.java index a796a6c03..dc5f9becd 100644 --- a/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsConfig.java +++ b/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.kms.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.kms") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface KmsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface KmsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsRecorder.java b/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsRecorder.java index d44808547..a186689e7 100644 --- a/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsRecorder.java +++ b/kms/runtime/src/main/java/io/quarkus/amazon/kms/runtime/KmsRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public KmsRecorder(KmsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/lambda/deployment/src/main/java/io/quarkus/amazon/lambda/deployment/LambdaProcessor.java b/lambda/deployment/src/main/java/io/quarkus/amazon/lambda/deployment/LambdaProcessor.java index afe4069fa..c1484da61 100644 --- a/lambda/deployment/src/main/java/io/quarkus/amazon/lambda/deployment/LambdaProcessor.java +++ b/lambda/deployment/src/main/java/io/quarkus/amazon/lambda/deployment/LambdaProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -78,12 +79,19 @@ void setup( setupExtension(extensionSslNativeSupport, feature, interceptors); } + @BuildStep + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + @BuildStep void discover( - final BeanRegistrationPhaseBuildItem beanRegistrationPhase, - final BuildProducer requireClientProducer) { + List amazonClientInjectionPoints, + BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -95,7 +103,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient( final List clientRequirements, - final BuildProducer clientProducer) { + final BuildProducer clientProducer) { setupClient( clientRequirements, @@ -108,7 +116,7 @@ void setupClient( @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) void setupApacheSyncTransport( - final List amazonClients, + final List amazonClients, final LambdaRecorder recorder, final AmazonClientApacheTransportRecorder transportRecorder, final BuildProducer syncTransports) { @@ -123,7 +131,7 @@ void setupApacheSyncTransport( @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, LambdaRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, LambdaRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -137,7 +145,7 @@ void setupAwsCrtSyncTransport(List amazonClients, LambdaR @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) void setupUrlConnectionSyncTransport( - final List amazonClients, + final List amazonClients, final LambdaRecorder recorder, final AmazonClientUrlConnectionTransportRecorder transportRecorder, final BuildProducer syncTransports) { @@ -153,7 +161,7 @@ void setupUrlConnectionSyncTransport( @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) void setupNettyAsyncTransport( - final List amazonClients, + final List amazonClients, final LambdaRecorder recorder, final AmazonClientNettyTransportRecorder transportRecorder, final LambdaConfig runtimeConfig, @@ -171,7 +179,8 @@ void setupNettyAsyncTransport( @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(final List amazonClients, final LambdaRecorder recorder, + void setupAwsCrtAsyncTransport(final List amazonClients, + final LambdaRecorder recorder, final AmazonClientAwsCrtTransportRecorder transportRecorder, final BuildProducer asyncTransports) { @@ -187,6 +196,7 @@ void setupAwsCrtAsyncTransport(final List amazonClients, void createClientBuilders(LambdaRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -201,6 +211,7 @@ void createClientBuilders(LambdaRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaConfig.java b/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaConfig.java index 962565b13..acaaabbd7 100644 --- a/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaConfig.java +++ b/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaConfig.java @@ -1,27 +1,16 @@ package io.quarkus.amazon.lambda.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.lambda") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface LambdaConfig { - - /** AWS SDK client configurations */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** AWS services configurations */ - @ConfigDocSection - AwsConfig aws(); +public interface LambdaConfig extends HasAmazonClientRuntimeConfig { /** Sync HTTP transport configurations */ @ConfigDocSection diff --git a/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaRecorder.java b/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaRecorder.java index cbf4579eb..1be9ccb39 100644 --- a/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaRecorder.java +++ b/lambda/runtime/src/main/java/io/quarkus/amazon/lambda/runtime/LambdaRecorder.java @@ -17,13 +17,8 @@ public LambdaRecorder(final LambdaConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/s3-transfer-manager/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3TransferManagerProcessor.java b/s3-transfer-manager/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3TransferManagerProcessor.java index 45b60d850..7f733747e 100644 --- a/s3-transfer-manager/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3TransferManagerProcessor.java +++ b/s3-transfer-manager/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3TransferManagerProcessor.java @@ -1,7 +1,5 @@ package io.quarkus.amazon.s3.deployment; -import java.util.Optional; - import jakarta.enterprise.context.ApplicationScoped; import org.jboss.jandex.AnnotationInstance; @@ -9,7 +7,8 @@ import org.jboss.jandex.DotName; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; -import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.runtime.ClientUtil; import io.quarkus.amazon.common.runtime.SdkAutoCloseableDestroyer; import io.quarkus.amazon.s3.deployment.S3CrtProcessor.IsAmazonCrtS3ClientPresent; import io.quarkus.amazon.s3.runtime.S3Crt; @@ -47,8 +46,9 @@ AdditionalBeanBuildItem producer() { } @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) - void requireS3CrtClient(BuildProducer requireClientProducer) { - requireClientProducer.produce(new RequireAmazonClientBuildItem(Optional.empty(), Optional.of(S3CRT_CLIENT))); + void requireS3CrtClient(BuildProducer requireClientInjectionProducer) { + requireClientInjectionProducer + .produce(new RequireAmazonClientInjectionBuildItem(S3CRT_CLIENT, ClientUtil.DEFAULT_CLIENT_NAME)); } @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) @@ -59,8 +59,9 @@ void createS3CrtTransferManager( syntheticBeans.produce(SyntheticBeanBuildItem.configure(S3TransferManager.class) .unremovable() .setRuntimeInit() + .defaultBean() + .addQualifier().annotation(S3Crt.class).done() .scope(ApplicationScoped.class) - .addQualifier(S3Crt.class) .createWith(recorder.getS3CrtTransferManager()) .destroyer(SdkAutoCloseableDestroyer.class) .addInjectionPoint(ClassType.create(S3AsyncClient.class), diff --git a/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3CrtProcessor.java b/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3CrtProcessor.java index 4184710e2..58ffa1721 100644 --- a/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3CrtProcessor.java +++ b/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3CrtProcessor.java @@ -5,14 +5,16 @@ import java.util.function.BooleanSupplier; import jakarta.enterprise.context.ApplicationScoped; +import jakarta.enterprise.inject.spi.DeploymentException; import org.jboss.jandex.ClassType; import org.jboss.jandex.DotName; import org.jboss.jandex.ParameterizedType; import org.jboss.jandex.Type; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; -import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; +import io.quarkus.amazon.common.runtime.ClientUtil; import io.quarkus.amazon.common.runtime.SdkAutoCloseableDestroyer; import io.quarkus.amazon.s3.runtime.S3BuildTimeConfig; import io.quarkus.amazon.s3.runtime.S3Crt; @@ -30,6 +32,7 @@ import io.quarkus.deployment.builditem.LaunchModeBuildItem; import io.quarkus.runtime.RuntimeValue; import software.amazon.awssdk.services.s3.S3AsyncClient; +import software.amazon.awssdk.services.s3.S3Client; import software.amazon.awssdk.services.s3.S3CrtAsyncClientBuilder; import software.amazon.awssdk.services.s3.internal.crt.S3CrtAsyncClient; @@ -37,6 +40,7 @@ public class S3CrtProcessor { public static final DotName S3CRT = DotName.createSimple(S3Crt.class); private static final DotName S3_ASYNC_CLIENT = DotName.createSimple(S3AsyncClient.class.getName()); + private static final DotName S3_CLIENT = DotName.createSimple(S3Client.class.getName()); S3BuildTimeConfig buildTimeConfig; @@ -51,13 +55,12 @@ protected DotName asyncClientName() { @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) AdditionalBeanBuildItem qualifiers() { - return AdditionalBeanBuildItem.unremovableOf(S3Crt.class); + return new AdditionalBeanBuildItem(S3Crt.class); } @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, - BuildProducer requireClientProducer) { - + BuildProducer requireClientInjectionProducer) { Optional asyncClassName = Optional.empty(); // Discover all clients injections in order to determine if s3 crt async client @@ -73,40 +76,45 @@ void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, if (S3_ASYNC_CLIENT.equals(injectedType.name())) { asyncClassName = Optional.of(asyncClientName()); } + + if (S3_CLIENT.equals(injectedType.name())) { + throw new DeploymentException("@S3Crt is only valid with S3AsyncClient instance."); + } } if (asyncClassName.isPresent()) { - requireClientProducer.produce(new RequireAmazonClientBuildItem(Optional.empty(), asyncClassName)); + requireClientInjectionProducer + .produce(new RequireAmazonClientInjectionBuildItem(asyncClassName.get(), ClientUtil.DEFAULT_CLIENT_NAME)); } } @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) - void setupClient(List clientRequirements, - BuildProducer clientProducer) { + void setupClient(List clientRequirements, + BuildProducer clientProducer) { Optional asyncClassName = Optional.empty(); - for (RequireAmazonClientBuildItem clientRequirement : clientRequirements) { + for (RequireAmazonClientInjectionBuildItem clientRequirement : clientRequirements) { - if (clientRequirement.getAsyncClassName().filter(asyncClientName()::equals).isPresent()) { - asyncClassName = clientRequirement.getAsyncClassName(); + if (clientRequirement.getClassName().equals(asyncClientName())) { + asyncClassName = Optional.of(clientRequirement.getClassName()); } } if (asyncClassName.isPresent()) { - clientProducer.produce(new AmazonClientBuildItem(Optional.empty(), asyncClassName, configName(), - buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient())); + clientProducer + .produce(new RequireAmazonClientTransportBuilderBuildItem(Optional.empty(), asyncClassName, configName(), + buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient())); } } @BuildStep(onlyIf = IsAmazonCrtS3ClientPresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void createS3CrtAsyncClient(List amazonClients, + void createS3CrtAsyncClient(List amazonClients, S3CrtRecorder recorder, BuildProducer syntheticBeans, ExecutorBuildItem executorBuildItem, LaunchModeBuildItem launchMode) { - - Optional matchingClientBuildItem = amazonClients.stream() + Optional matchingClientBuildItem = amazonClients.stream() .filter(c -> c.getAwsClientName().equals(configName())) .findAny(); @@ -137,7 +145,6 @@ void createS3CrtAsyncClient(List amazonClients, .destroyer(SdkAutoCloseableDestroyer.class) .addInjectionPoint(ClassType.create(S3CrtAsyncClientBuilder.class)) .done()); - }); } diff --git a/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3Processor.java b/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3Processor.java index 5687ec232..a00fe3855 100644 --- a/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3Processor.java +++ b/s3/deployment/src/main/java/io/quarkus/amazon/s3/deployment/S3Processor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -86,10 +87,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -100,7 +109,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -108,7 +117,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, S3Recorder recorder, + void setupApacheSyncTransport(List amazonClients, S3Recorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -121,7 +130,7 @@ void setupApacheSyncTransport(List amazonClients, S3Recor @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, S3Recorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, S3Recorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -134,7 +143,7 @@ void setupAwsCrtSyncTransport(List amazonClients, S3Recor @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, S3Recorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, S3Recorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -147,7 +156,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, S3Recorder recorder, + void setupNettyAsyncTransport(List amazonClients, S3Recorder recorder, AmazonClientNettyTransportRecorder transportRecorder, S3Config runtimeConfig, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -161,7 +170,7 @@ void setupNettyAsyncTransport(List amazonClients, S3Recor @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, S3Recorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, S3Recorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -177,6 +186,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, S3Reco void createClientBuilders(S3Recorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -191,6 +201,7 @@ void createClientBuilders(S3Recorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CrtClientTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CrtClientTest.java new file mode 100644 index 000000000..78f882eac --- /dev/null +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CrtClientTest.java @@ -0,0 +1,32 @@ +package io.quarkus.amazon.s3.deployment; + +import static org.junit.jupiter.api.Assertions.assertNotNull; + +import jakarta.enterprise.inject.Instance; +import jakarta.inject.Inject; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import io.quarkus.amazon.s3.runtime.S3Crt; +import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.services.s3.S3AsyncClient; + +public class S3CrtClientTest { + + @Inject + @S3Crt + Instance client; + + @RegisterExtension + static final QuarkusUnitTest config = new QuarkusUnitTest() + .withApplicationRoot((jar) -> jar + .addAsResource("sync-urlconn-full-config.properties", "application.properties")); + + @Test + public void test() { + assertNotNull(client.get()); + // should finish with success + client.get().close(); + } +} diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameNamedClientTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameNamedClientTest.java new file mode 100644 index 000000000..6a9e27f62 --- /dev/null +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameNamedClientTest.java @@ -0,0 +1,37 @@ +package io.quarkus.amazon.s3.deployment; + +import static org.hamcrest.MatcherAssert.*; +import static org.hamcrest.Matchers.equalTo; + +import jakarta.enterprise.inject.Instance; +import jakarta.inject.Inject; + +import org.junit.jupiter.api.*; +import org.junit.jupiter.api.extension.*; + +import io.quarkus.amazon.common.AmazonClient; +import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.services.s3.S3Client; + +class S3CustomCredentialsProviderMissedBeanNameNamedClientTest { + + @Inject + @AmazonClient("custom") + Instance client; + + @RegisterExtension + static final QuarkusUnitTest config = new QuarkusUnitTest() + .assertException(throwable -> { + assertThat(throwable.getMessage(), + equalTo("quarkus.s3.custom.aws.credentials.custom-provider.name cannot be empty if CUSTOM credentials provider used.")); + }) + .withApplicationRoot((jar) -> jar + .addAsResource("custom-credentials-provider-missed-name-named-client.properties", + "application.properties")); + + @Test + void test() { + Assertions.fail(); + } + +} diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameTest.java index 97e1e6385..32bbd4a04 100644 --- a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameTest.java +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanNameTest.java @@ -3,13 +3,20 @@ import static org.hamcrest.MatcherAssert.*; import static org.hamcrest.Matchers.equalTo; +import jakarta.enterprise.inject.Instance; +import jakarta.inject.Inject; + import org.junit.jupiter.api.*; import org.junit.jupiter.api.extension.*; import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.services.s3.S3Client; class S3CustomCredentialsProviderMissedBeanNameTest { + @Inject + Instance client; + @RegisterExtension static final QuarkusUnitTest config = new QuarkusUnitTest() .assertException(throwable -> { diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanTest.java index cd7e89a59..f291fbc7a 100644 --- a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanTest.java +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3CustomCredentialsProviderMissedBeanTest.java @@ -3,13 +3,20 @@ import static org.hamcrest.MatcherAssert.*; import static org.hamcrest.Matchers.equalTo; +import jakarta.enterprise.inject.Instance; +import jakarta.inject.Inject; + import org.junit.jupiter.api.*; import org.junit.jupiter.api.extension.*; import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.services.s3.S3Client; class S3CustomCredentialsProviderMissedBeanTest { + @Inject + Instance client; + @RegisterExtension static final QuarkusUnitTest config = new QuarkusUnitTest() .assertException(throwable -> { diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3DevServicesTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3DevServicesTest.java index 26d81bb83..327788ebc 100644 --- a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3DevServicesTest.java +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3DevServicesTest.java @@ -13,15 +13,21 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; +import io.quarkus.amazon.common.AmazonClient; import io.quarkus.test.QuarkusUnitTest; import software.amazon.awssdk.services.s3.S3Client; import software.amazon.awssdk.services.s3.model.Bucket; +import software.amazon.awssdk.services.s3.presigner.S3Presigner; public class S3DevServicesTest { @Inject Instance client; + @Inject + @AmazonClient("test") + Instance clientNamed; + @RegisterExtension static final QuarkusUnitTest config = new QuarkusUnitTest() .withApplicationRoot((jar) -> jar @@ -30,6 +36,7 @@ public class S3DevServicesTest { @Test public void test() { + assertNotNull(clientNamed.get()); assertNotNull(client.get()); Assertions.assertEquals(Set.of("default"), client.get().listBuckets().buckets().stream().map(Bucket::name).collect(Collectors.toSet())); diff --git a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3SyncClientFullConfigTest.java b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3SyncClientFullConfigTest.java index 3d10a392f..20bafb097 100644 --- a/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3SyncClientFullConfigTest.java +++ b/s3/deployment/src/test/java/io/quarkus/amazon/s3/deployment/S3SyncClientFullConfigTest.java @@ -2,20 +2,31 @@ import static org.junit.jupiter.api.Assertions.assertNotNull; +import jakarta.enterprise.inject.Any; import jakarta.enterprise.inject.Instance; import jakarta.inject.Inject; import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; +import io.quarkus.amazon.common.AmazonClient; import io.quarkus.test.QuarkusUnitTest; import software.amazon.awssdk.services.s3.S3Client; +import software.amazon.awssdk.services.s3.S3ClientBuilder; public class S3SyncClientFullConfigTest { @Inject Instance client; + @Inject + @AmazonClient("custom") + Instance clientCustom; + + @Inject + @Any + Instance builder; + @RegisterExtension static final QuarkusUnitTest config = new QuarkusUnitTest() .withApplicationRoot((jar) -> jar @@ -23,7 +34,12 @@ public class S3SyncClientFullConfigTest { @Test public void test() { - assertNotNull(client.get()); + //assertNotNull(client.get()); + assertNotNull(clientCustom.get()); + // should finish with success + client.get().close(); + clientCustom.get().close(); + } } diff --git a/s3/deployment/src/test/resources/custom-credentials-provider-missed-name-named-client.properties b/s3/deployment/src/test/resources/custom-credentials-provider-missed-name-named-client.properties new file mode 100644 index 000000000..549c15f6e --- /dev/null +++ b/s3/deployment/src/test/resources/custom-credentials-provider-missed-name-named-client.properties @@ -0,0 +1,3 @@ +quarkus.devservices.enabled=false +quarkus.s3.aws.region=us-east-2 +quarkus.s3.custom.aws.credentials.type=custom \ No newline at end of file diff --git a/s3/deployment/src/test/resources/sync-urlconn-full-config.properties b/s3/deployment/src/test/resources/sync-urlconn-full-config.properties index 627b52027..9a7fe9260 100644 --- a/s3/deployment/src/test/resources/sync-urlconn-full-config.properties +++ b/s3/deployment/src/test/resources/sync-urlconn-full-config.properties @@ -4,7 +4,7 @@ quarkus.s3.chunked-encoding=true quarkus.s3.dualstack=false quarkus.s3.path-style-access=false quarkus.s3.use-arn-region-enabled=true -quarkus.s3.profile-name=foo +#quarkus.s3.profile-name=foo quarkus.s3.endpoint-override=http://localhost:9090 diff --git a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Config.java b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Config.java index bc253e202..86cf7aaa1 100644 --- a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Config.java +++ b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Config.java @@ -3,19 +3,17 @@ import java.util.Optional; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; import io.smallrye.config.WithDefault; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.s3") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface S3Config { +public interface S3Config extends HasAmazonClientRuntimeConfig { /** * Enable using the accelerate endpoint when accessing S3. @@ -71,19 +69,6 @@ public interface S3Config { */ Optional profileName(); - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - /** * Sync HTTP transport configurations */ diff --git a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3CrtRecorder.java b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3CrtRecorder.java index fac8e6e0f..7a507488a 100644 --- a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3CrtRecorder.java +++ b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3CrtRecorder.java @@ -4,11 +4,16 @@ import java.util.concurrent.Executor; import java.util.function.Function; +import io.quarkus.amazon.common.runtime.AwsConfig; +import io.quarkus.amazon.common.runtime.ClientUtil; import io.quarkus.amazon.common.runtime.RuntimeConfigurationError; +import io.quarkus.amazon.common.runtime.SdkConfig; import io.quarkus.arc.SyntheticCreationalContext; import io.quarkus.runtime.LaunchMode; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; +import software.amazon.awssdk.auth.credentials.AwsCredentialsProvider; +import software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider; import software.amazon.awssdk.services.s3.S3AsyncClient; import software.amazon.awssdk.services.s3.S3CrtAsyncClientBuilder; import software.amazon.awssdk.utils.StringUtils; @@ -42,12 +47,18 @@ private void configureS3Client(S3CrtAsyncClientBuilder builder, String awsServic config.crtClient().targetThroughputInGbps().ifPresent(builder::targetThroughputInGbps); config.crtClient().maxNativeMemoryLimitInBytes().ifPresent(builder::maxNativeMemoryLimitInBytes); - config.aws().region().ifPresent(builder::region); - builder.credentialsProvider( - config.aws().credentials().type().create(config.aws().credentials(), "quarkus." + awsServiceName)); + AwsConfig awsConfig = config.clients().get(ClientUtil.DEFAULT_CLIENT_NAME).aws(); + SdkConfig sdkConfig = config.clients().get(ClientUtil.DEFAULT_CLIENT_NAME).sdk(); - if (config.sdk().endpointOverride().isPresent()) { - URI endpointOverride = config.sdk().endpointOverride().get(); + awsConfig.region().ifPresent(builder::region); + AwsCredentialsProvider credential = awsConfig.credentials().map(c -> c.type().create(c, "quarkus." + awsServiceName)) + .orElseGet(() -> DefaultCredentialsProvider.builder().asyncCredentialUpdateEnabled(false) + .reuseLastProviderEnabled(false).build()); + + builder.credentialsProvider(credential); + + if (sdkConfig.endpointOverride().isPresent()) { + URI endpointOverride = sdkConfig.endpointOverride().get(); if (StringUtils.isBlank(endpointOverride.getScheme())) { throw new RuntimeConfigurationError( String.format("quarkus.%s.endpoint-override (%s) - scheme must be specified", @@ -56,7 +67,7 @@ private void configureS3Client(S3CrtAsyncClientBuilder builder, String awsServic } } - config.sdk().endpointOverride().filter(URI::isAbsolute).ifPresent(builder::endpointOverride); + sdkConfig.endpointOverride().filter(URI::isAbsolute).ifPresent(builder::endpointOverride); } public RuntimeValue setExecutor(RuntimeValue builder, diff --git a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Recorder.java b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Recorder.java index bdbe378b0..0731a5be1 100644 --- a/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Recorder.java +++ b/s3/runtime/src/main/java/io/quarkus/amazon/s3/runtime/S3Recorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -28,13 +27,8 @@ public S3Recorder(S3Config config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override @@ -51,7 +45,6 @@ public SyncHttpClientConfig getSyncClientConfig() { public AwsSyncClientBuilder geSyncClientBuilder() { S3ClientBuilder builder = S3Client.builder(); configureS3Client(builder); - return builder; } diff --git a/secretsmanager/deployment/src/main/java/io/quarkus/amazon/secretsmanager/deployment/SecretsManagerProcessor.java b/secretsmanager/deployment/src/main/java/io/quarkus/amazon/secretsmanager/deployment/SecretsManagerProcessor.java index b8d8530ce..e134f4364 100644 --- a/secretsmanager/deployment/src/main/java/io/quarkus/amazon/secretsmanager/deployment/SecretsManagerProcessor.java +++ b/secretsmanager/deployment/src/main/java/io/quarkus/amazon/secretsmanager/deployment/SecretsManagerProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,8 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SecretsManagerRecorder recorder, + void setupApacheSyncTransport(List amazonClients, + SecretsManagerRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +124,8 @@ void setupApacheSyncTransport(List amazonClients, Secrets @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SecretsManagerRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, + SecretsManagerRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +138,8 @@ void setupAwsCrtSyncTransport(List amazonClients, Secrets @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SecretsManagerRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, + SecretsManagerRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +152,8 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SecretsManagerRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, + SecretsManagerRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +167,8 @@ void setupNettyAsyncTransport(List amazonClients, Secrets @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SecretsManagerRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, + SecretsManagerRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +184,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, Secret void createClientBuilders(SecretsManagerRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +199,7 @@ void createClientBuilders(SecretsManagerRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerConfig.java b/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerConfig.java index b9091a794..5cc5c6cbd 100644 --- a/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerConfig.java +++ b/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.secretsmanager.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.secretsmanager") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface SecretsManagerConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SecretsManagerConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerRecorder.java b/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerRecorder.java index 83927135f..ca1d801fa 100644 --- a/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerRecorder.java +++ b/secretsmanager/runtime/src/main/java/io/quarkus/amazon/secretsmanager/runtime/SecretsManagerRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SecretsManagerRecorder(SecretsManagerConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/ses/deployment/src/main/java/io/quarkus/amazon/ses/deployment/SesProcessor.java b/ses/deployment/src/main/java/io/quarkus/amazon/ses/deployment/SesProcessor.java index eed34a4c0..254d11e53 100644 --- a/ses/deployment/src/main/java/io/quarkus/amazon/ses/deployment/SesProcessor.java +++ b/ses/deployment/src/main/java/io/quarkus/amazon/ses/deployment/SesProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -80,10 +81,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -94,7 +103,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -102,7 +111,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SesRecorder recorder, + void setupApacheSyncTransport(List amazonClients, SesRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, SesConfig runtimeConfig, BuildProducer syncTransports) { @@ -115,7 +124,7 @@ void setupApacheSyncTransport(List amazonClients, SesReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SesRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, SesRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -128,7 +137,7 @@ void setupAwsCrtSyncTransport(List amazonClients, SesReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SesRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, SesRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, SesConfig runtimeConfig, BuildProducer syncTransports) { @@ -141,7 +150,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SesRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, SesRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, SesConfig runtimeConfig, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -155,7 +164,7 @@ void setupNettyAsyncTransport(List amazonClients, SesReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SesRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, SesRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -171,6 +180,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, SesRec void createClientBuilders(SesRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -185,6 +195,7 @@ void createClientBuilders(SesRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesConfig.java b/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesConfig.java index af632ae78..14326814f 100644 --- a/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesConfig.java +++ b/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.ses.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.ses") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface SesConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SesConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesRecorder.java b/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesRecorder.java index 2eb9c2a44..8f23ab6d0 100644 --- a/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesRecorder.java +++ b/ses/runtime/src/main/java/io/quarkus/amazon/ses/runtime/SesRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SesRecorder(SesConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/sfn/deployment/src/main/java/io/quarkus/amazon/sfn/deployment/SfnProcessor.java b/sfn/deployment/src/main/java/io/quarkus/amazon/sfn/deployment/SfnProcessor.java index 3b90632e9..fe4f50cba 100644 --- a/sfn/deployment/src/main/java/io/quarkus/amazon/sfn/deployment/SfnProcessor.java +++ b/sfn/deployment/src/main/java/io/quarkus/amazon/sfn/deployment/SfnProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -80,10 +81,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -94,7 +103,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -102,7 +111,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SfnRecorder recorder, + void setupApacheSyncTransport(List amazonClients, SfnRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, SfnConfig runtimeConfig, BuildProducer syncTransports) { @@ -115,7 +124,7 @@ void setupApacheSyncTransport(List amazonClients, SfnReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SfnRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, SfnRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -128,7 +137,7 @@ void setupAwsCrtSyncTransport(List amazonClients, SfnReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SfnRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, SfnRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, SfnConfig runtimeConfig, BuildProducer syncTransports) { @@ -141,7 +150,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SfnRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, SfnRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, SfnConfig runtimeConfig, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -155,7 +164,7 @@ void setupNettyAsyncTransport(List amazonClients, SfnReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SfnRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, SfnRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -171,6 +180,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, SfnRec void createClientBuilders(SfnRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -185,6 +195,7 @@ void createClientBuilders(SfnRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnConfig.java b/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnConfig.java index 09c3f5290..72eee0804 100644 --- a/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnConfig.java +++ b/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.sfn.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.sfn") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface SfnConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SfnConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnRecorder.java b/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnRecorder.java index b03743667..a23112a03 100644 --- a/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnRecorder.java +++ b/sfn/runtime/src/main/java/io/quarkus/amazon/sfn/runtime/SfnRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SfnRecorder(SfnConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/sns/deployment/src/main/java/io/quarkus/amazon/sns/deployment/SnsProcessor.java b/sns/deployment/src/main/java/io/quarkus/amazon/sns/deployment/SnsProcessor.java index e878153ef..0bb0daa29 100644 --- a/sns/deployment/src/main/java/io/quarkus/amazon/sns/deployment/SnsProcessor.java +++ b/sns/deployment/src/main/java/io/quarkus/amazon/sns/deployment/SnsProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SnsRecorder recorder, + void setupApacheSyncTransport(List amazonClients, SnsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, SnsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SnsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, SnsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, SnsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SnsRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, SnsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SnsRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, SnsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, SnsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SnsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, SnsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, SnsRec void createClientBuilders(SnsRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(SnsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsConfig.java b/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsConfig.java index 1e36d11c4..361482e21 100644 --- a/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsConfig.java +++ b/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.sns.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigRoot(phase = ConfigPhase.RUN_TIME) @ConfigMapping(prefix = "quarkus.sns") -public interface SnsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SnsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsRecorder.java b/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsRecorder.java index e3ccbb980..cbcdfc6d9 100644 --- a/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsRecorder.java +++ b/sns/runtime/src/main/java/io/quarkus/amazon/sns/runtime/SnsRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SnsRecorder(SnsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/sqs/deployment/src/main/java/io/quarkus/amazon/sqs/deployment/SqsProcessor.java b/sqs/deployment/src/main/java/io/quarkus/amazon/sqs/deployment/SqsProcessor.java index 47ccabdd7..2696927bc 100644 --- a/sqs/deployment/src/main/java/io/quarkus/amazon/sqs/deployment/SqsProcessor.java +++ b/sqs/deployment/src/main/java/io/quarkus/amazon/sqs/deployment/SqsProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SqsRecorder recorder, + void setupApacheSyncTransport(List amazonClients, SqsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, SqsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SqsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, SqsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, SqsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SqsRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, SqsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SqsRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, SqsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, SqsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SqsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, SqsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, SqsRec void createClientBuilders(SqsRecorder recorder, AmazonClientCommonRecorder commonRecorder, SqsOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(SqsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/sqs/deployment/src/test/java/io/quarkus/amazon/sqs/deployment/SqsDevServicesWithoutQueueTest.java b/sqs/deployment/src/test/java/io/quarkus/amazon/sqs/deployment/SqsDevServicesWithoutQueueTest.java index 271654a52..cb39e554c 100644 --- a/sqs/deployment/src/test/java/io/quarkus/amazon/sqs/deployment/SqsDevServicesWithoutQueueTest.java +++ b/sqs/deployment/src/test/java/io/quarkus/amazon/sqs/deployment/SqsDevServicesWithoutQueueTest.java @@ -10,6 +10,7 @@ import org.junit.jupiter.api.Test; import org.junit.jupiter.api.extension.RegisterExtension; +import io.quarkus.amazon.common.AmazonClient; import io.quarkus.test.QuarkusUnitTest; import software.amazon.awssdk.services.sqs.SqsClient; @@ -18,6 +19,10 @@ class SqsDevServicesWithoutQueueTest { @Inject Instance client; + @Inject + @AmazonClient("test") + Instance clientNamed; + @RegisterExtension static final QuarkusUnitTest config = new QuarkusUnitTest() .withApplicationRoot((jar) -> jar @@ -28,5 +33,7 @@ class SqsDevServicesWithoutQueueTest { void test() { assertNotNull(client.get()); assertTrue(client.get().listQueues().queueUrls().isEmpty()); + assertNotNull(clientNamed.get()); + assertTrue(clientNamed.get().listQueues().queueUrls().isEmpty()); } } diff --git a/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsConfig.java b/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsConfig.java index b07e77501..4b9213c43 100644 --- a/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsConfig.java +++ b/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.sqs.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.sqs") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface SqsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SqsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsRecorder.java b/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsRecorder.java index f33d1c4f5..465de6717 100644 --- a/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsRecorder.java +++ b/sqs/runtime/src/main/java/io/quarkus/amazon/sqs/runtime/SqsRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SqsRecorder(SqsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/ssm/deployment/src/main/java/io/quarkus/amazon/ssm/deployment/SsmProcessor.java b/ssm/deployment/src/main/java/io/quarkus/amazon/ssm/deployment/SsmProcessor.java index ef25c340d..c4c1f43dd 100644 --- a/ssm/deployment/src/main/java/io/quarkus/amazon/ssm/deployment/SsmProcessor.java +++ b/ssm/deployment/src/main/java/io/quarkus/amazon/ssm/deployment/SsmProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, SsmRecorder recorder, + void setupApacheSyncTransport(List amazonClients, SsmRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, SsmReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, SsmRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, SsmRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, SsmReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, SsmRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, SsmRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, SsmRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, SsmRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, SsmReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, SsmRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, SsmRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, SsmRec void createClientBuilders(SsmRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(SsmRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmConfig.java b/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmConfig.java index aa8f03f62..019bab926 100644 --- a/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmConfig.java +++ b/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.ssm.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.ssm") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface SsmConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface SsmConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmRecorder.java b/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmRecorder.java index f0b3d8d39..ce4cb1075 100644 --- a/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmRecorder.java +++ b/ssm/runtime/src/main/java/io/quarkus/amazon/ssm/runtime/SsmRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public SsmRecorder(SsmConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override diff --git a/sts/deployment/src/main/java/io/quarkus/amazon/sts/deployment/StsProcessor.java b/sts/deployment/src/main/java/io/quarkus/amazon/sts/deployment/StsProcessor.java index 24dbab727..bed0cc31b 100644 --- a/sts/deployment/src/main/java/io/quarkus/amazon/sts/deployment/StsProcessor.java +++ b/sts/deployment/src/main/java/io/quarkus/amazon/sts/deployment/StsProcessor.java @@ -7,12 +7,13 @@ import io.quarkus.amazon.common.deployment.AbstractAmazonServiceProcessor; import io.quarkus.amazon.common.deployment.AmazonClientAsyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; -import io.quarkus.amazon.common.deployment.AmazonClientBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncResultBuildItem; import io.quarkus.amazon.common.deployment.AmazonClientSyncTransportBuildItem; import io.quarkus.amazon.common.deployment.AmazonHttpClients; import io.quarkus.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkus.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; import io.quarkus.amazon.common.deployment.RequireAmazonTelemetryBuildItem; import io.quarkus.amazon.common.deployment.spi.EventLoopGroupBuildItem; import io.quarkus.amazon.common.runtime.AmazonClientApacheTransportRecorder; @@ -79,10 +80,18 @@ void setup( } @BuildStep - void discover(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, BuildProducer requireClientProducer) { - discoverClient(beanRegistrationPhase, requireClientProducer); + discoverClient(amazonClientInjectionPoints, requireClientProducer); } @BuildStep @@ -93,7 +102,7 @@ void discoverTelemetry(BuildProducer telemetryP @BuildStep void setupClient(List clientRequirements, - BuildProducer clientProducer) { + BuildProducer clientProducer) { setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), buildTimeConfig.asyncClient()); @@ -101,7 +110,7 @@ void setupClient(List clientRequirements, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupApacheSyncTransport(List amazonClients, StsRecorder recorder, + void setupApacheSyncTransport(List amazonClients, StsRecorder recorder, AmazonClientApacheTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -114,7 +123,7 @@ void setupApacheSyncTransport(List amazonClients, StsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtSyncTransport(List amazonClients, StsRecorder recorder, + void setupAwsCrtSyncTransport(List amazonClients, StsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -127,7 +136,7 @@ void setupAwsCrtSyncTransport(List amazonClients, StsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupUrlConnectionSyncTransport(List amazonClients, StsRecorder recorder, + void setupUrlConnectionSyncTransport(List amazonClients, StsRecorder recorder, AmazonClientUrlConnectionTransportRecorder transportRecorder, BuildProducer syncTransports) { @@ -140,7 +149,7 @@ void setupUrlConnectionSyncTransport(List amazonClients, @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupNettyAsyncTransport(List amazonClients, StsRecorder recorder, + void setupNettyAsyncTransport(List amazonClients, StsRecorder recorder, AmazonClientNettyTransportRecorder transportRecorder, BuildProducer asyncTransports, EventLoopGroupBuildItem eventLoopSupplier) { @@ -154,7 +163,7 @@ void setupNettyAsyncTransport(List amazonClients, StsReco @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) @Record(ExecutionTime.RUNTIME_INIT) - void setupAwsCrtAsyncTransport(List amazonClients, StsRecorder recorder, + void setupAwsCrtAsyncTransport(List amazonClients, StsRecorder recorder, AmazonClientAwsCrtTransportRecorder transportRecorder, BuildProducer asyncTransports) { @@ -170,6 +179,7 @@ void setupAwsCrtAsyncTransport(List amazonClients, StsRec void createClientBuilders(StsRecorder recorder, AmazonClientCommonRecorder commonRecorder, AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, List amazonRequireTelemtryClients, List syncTransports, List asyncTransports, @@ -184,6 +194,7 @@ void createClientBuilders(StsRecorder recorder, commonRecorder, otelRecorder, buildTimeConfig, + amazonClientInjections, amazonRequireTelemtryClients, syncTransports, asyncTransports, diff --git a/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsConfig.java b/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsConfig.java index b44527893..facabc8b0 100644 --- a/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsConfig.java +++ b/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsConfig.java @@ -1,31 +1,16 @@ package io.quarkus.amazon.sts.runtime; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.annotations.ConfigDocSection; import io.quarkus.runtime.annotations.ConfigPhase; import io.quarkus.runtime.annotations.ConfigRoot; import io.smallrye.config.ConfigMapping; -import io.smallrye.config.WithParentName; @ConfigMapping(prefix = "quarkus.sts") @ConfigRoot(phase = ConfigPhase.RUN_TIME) -public interface StsConfig { - /** - * AWS SDK client configurations - */ - @WithParentName - @ConfigDocSection - SdkConfig sdk(); - - /** - * AWS services configurations - */ - @ConfigDocSection - AwsConfig aws(); - +public interface StsConfig extends HasAmazonClientRuntimeConfig { /** * Sync HTTP transport configurations */ diff --git a/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsRecorder.java b/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsRecorder.java index 15ce96932..49494dd88 100644 --- a/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsRecorder.java +++ b/sts/runtime/src/main/java/io/quarkus/amazon/sts/runtime/StsRecorder.java @@ -2,8 +2,7 @@ import io.quarkus.amazon.common.runtime.AmazonClientRecorder; import io.quarkus.amazon.common.runtime.AsyncHttpClientConfig; -import io.quarkus.amazon.common.runtime.AwsConfig; -import io.quarkus.amazon.common.runtime.SdkConfig; +import io.quarkus.amazon.common.runtime.HasAmazonClientRuntimeConfig; import io.quarkus.amazon.common.runtime.SyncHttpClientConfig; import io.quarkus.runtime.RuntimeValue; import io.quarkus.runtime.annotations.Recorder; @@ -22,13 +21,8 @@ public StsRecorder(StsConfig config) { } @Override - public RuntimeValue getAwsConfig() { - return new RuntimeValue<>(config.aws()); - } - - @Override - public RuntimeValue getSdkConfig() { - return new RuntimeValue<>(config.sdk()); + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); } @Override