From b090b646e3a4d8928aa192490124ba59846d1185 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Crocquesel?= <88554524+scrocquesel@users.noreply.github.com> Date: Fri, 15 Nov 2024 23:57:33 +0100 Subject: [PATCH] feat: add neptune extension --- README.md | 1 + bom/pom.xml | 41 +- docs/modules/ROOT/nav.adoc | 1 + .../pages/amazon-apigatewaymanagementapi.adoc | 2 +- docs/modules/ROOT/pages/amazon-neptune.adoc | 17 + .../ROOT/pages/includes/attributes.adoc | 2 +- .../includes/quarkus-amazon-neptune.adoc | 1748 +++++++++++++++++ ...uarkus-amazon-neptune_quarkus.neptune.adoc | 1748 +++++++++++++++++ ...us-amazon-paymentcryptography_quarkus.adoc | 1748 +++++++++++++++++ ...mazon-paymentcryptographydata_quarkus.adoc | 1748 +++++++++++++++++ .../it/amazon/acm/AcmResource.java | 10 +- .../quarkiverse/it/amazon/AmazonAcmTest.java | 7 +- neptune/deployment/pom.xml | 83 + .../neptune/deployment/NeptuneProcessor.java | 211 ++ .../NeptuneSyncClientFullConfigTest.java | 29 + .../sync-urlconn-full-config.properties | 10 + neptune/pom.xml | 21 + neptune/runtime/pom.xml | 99 + .../runtime/NeptuneBuildTimeConfig.java | 32 + .../amazon/neptune/runtime/NeptuneConfig.java | 25 + .../neptune/runtime/NeptuneRecorder.java | 47 + .../resources/META-INF/quarkus-extension.yaml | 14 + pom.xml | 1 + 23 files changed, 7621 insertions(+), 24 deletions(-) create mode 100644 docs/modules/ROOT/pages/amazon-neptune.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-neptune.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-neptune_quarkus.neptune.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptography_quarkus.adoc create mode 100644 docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptographydata_quarkus.adoc create mode 100644 neptune/deployment/pom.xml create mode 100644 neptune/deployment/src/main/java/io/quarkiverse/amazon/neptune/deployment/NeptuneProcessor.java create mode 100644 neptune/deployment/src/test/java/io/quarkiverse/amazon/neptune/deployment/NeptuneSyncClientFullConfigTest.java create mode 100644 neptune/deployment/src/test/resources/sync-urlconn-full-config.properties create mode 100644 neptune/pom.xml create mode 100644 neptune/runtime/pom.xml create mode 100644 neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneBuildTimeConfig.java create mode 100644 neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneConfig.java create mode 100644 neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneRecorder.java create mode 100644 neptune/runtime/src/main/resources/META-INF/quarkus-extension.yaml diff --git a/README.md b/README.md index e2ba6d6b..2893b25b 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ This set of extensions allows you to interact with some of the AWS Services name * Kinesis * KMS * Lambda + * Neptune * Payment Cryptography / Payment Cryptography Data * S3 * S3 Transfer Manager diff --git a/bom/pom.xml b/bom/pom.xml index 898f4099..1bfbae7d 100644 --- a/bom/pom.xml +++ b/bom/pom.xml @@ -97,6 +97,21 @@ quarkus-amazon-crt-client-internal-deployment ${project.version} + + io.quarkiverse.amazonservices + quarkus-amazon-devservices-acm + ${project.version} + + + io.quarkiverse.amazonservices + quarkus-amazon-acm + ${project.version} + + + io.quarkiverse.amazonservices + quarkus-amazon-acm-deployment + ${project.version} + io.quarkiverse.amazonservices quarkus-amazon-apigatewaymanagementapi @@ -227,6 +242,16 @@ quarkus-amazon-kms-deployment ${project.version} + + io.quarkiverse.amazonservices + quarkus-amazon-neptune + ${project.version} + + + io.quarkiverse.amazonservices + quarkus-amazon-neptune-deployment + ${project.version} + io.quarkiverse.amazonservices quarkus-amazon-devservices-s3 @@ -449,21 +474,7 @@ quarkus-amazon-devservices-sfn ${project.version} - - io.quarkiverse.amazonservices - quarkus-amazon-devservices-acm - ${project.version} - - - io.quarkiverse.amazonservices - quarkus-amazon-acm - ${project.version} - - - io.quarkiverse.amazonservices - quarkus-amazon-acm-deployment - ${project.version} - + \ No newline at end of file diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 68e353b7..70f76aed 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -12,6 +12,7 @@ * xref:amazon-kinesis.adoc[Kinesis] * xref:amazon-kms.adoc[KMS] * xref:amazon-lambda.adoc[Lambda] +* xref:amazon-neptune.adoc[Neptune] * xref:amazon-paymentcryptography.adoc[Payment Cryptography] * xref:amazon-paymentcryptographydata.adoc[Payment Cryptography Data] * xref:amazon-s3.adoc[S3] diff --git a/docs/modules/ROOT/pages/amazon-apigatewaymanagementapi.adoc b/docs/modules/ROOT/pages/amazon-apigatewaymanagementapi.adoc index db842a28..d3fa90b5 100644 --- a/docs/modules/ROOT/pages/amazon-apigatewaymanagementapi.adoc +++ b/docs/modules/ROOT/pages/amazon-apigatewaymanagementapi.adoc @@ -6,7 +6,7 @@ Amazon API Gateway Management Api allows you to create, maintain, and secure API You can find more information about API Gateway Management Api at https://aws.amazon.com/api-gateway/[the Amazon API Gateway website]. -NOTE: The PAPI Gateway Management Api extension is based on https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html[AWS Java SDK 2.x]. +NOTE: The API Gateway Management Api extension is based on https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html[AWS Java SDK 2.x]. It's a major rewrite of the 1.x code base that offers two programming models (Blocking & Async). The Quarkus extension supports two programming models: diff --git a/docs/modules/ROOT/pages/amazon-neptune.adoc b/docs/modules/ROOT/pages/amazon-neptune.adoc new file mode 100644 index 00000000..eee29a85 --- /dev/null +++ b/docs/modules/ROOT/pages/amazon-neptune.adoc @@ -0,0 +1,17 @@ += Amazon Neptune Client + +include::./includes/attributes.adoc[] + +Amazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. + +You can find more information about Neptune at https://docs.aws.amazon.com/neptune/[the Amazon Neptune website]. + +NOTE: The Neptune extension is based on https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/welcome.html[AWS Java SDK 2.x]. +It's a major rewrite of the 1.x code base that offers two programming models (Blocking & Async). + +The Quarkus extension supports two programming models: + +* Blocking access using URL Connection HTTP client (by default) or the Apache HTTP Client +* https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/basics-async.html[Asynchronous programming] based on JDK's `CompletableFuture` objects and the Netty HTTP client (by default) or the AWS CRT-based HTTP client + +include::./includes/quarkus-amazon-neptune.adoc[] diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc index 1a31859c..72255241 100644 --- a/docs/modules/ROOT/pages/includes/attributes.adoc +++ b/docs/modules/ROOT/pages/includes/attributes.adoc @@ -1,4 +1,4 @@ -:quarkus-version: 3.16.0 +:quarkus-version: 3.16.2 :quarkus-amazon-services-version: 3.0.1 :maven-version: 3.8.1+ diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune.adoc new file mode 100644 index 00000000..8381a70c --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune.adoc @@ -0,0 +1,1748 @@ +[.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-neptune_quarkus-neptune-interceptors]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-interceptors[`quarkus.neptune.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_NEPTUNE_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-telemetry-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-telemetry-enabled[`quarkus.neptune.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_NEPTUNE_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-sync-client-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`url`, `apache`, `aws-crt` +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-async-client-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`netty`, `aws-crt` +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-enabled[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-shared]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-shared[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-isolated]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-isolated[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-service-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-service-name[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-container-properties-container-properties]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-container-properties-container-properties[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-neptune_section_quarkus-neptune]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune[AWS SDK client configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-endpoint-override]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-endpoint-override[`quarkus.neptune.endpoint-override`]## + +`quarkus.neptune."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_NEPTUNE_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-api-call-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-api-call-timeout[`quarkus.neptune.api-call-timeout`]## + +`quarkus.neptune."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_NEPTUNE_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-api-call-attempt-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-api-call-attempt-timeout[`quarkus.neptune.api-call-attempt-timeout`]## + +`quarkus.neptune."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_NEPTUNE_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-advanced-use-quarkus-scheduled-executor-service[`quarkus.neptune.advanced.use-quarkus-scheduled-executor-service`]## + +`quarkus.neptune."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_NEPTUNE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws[AWS services configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-region]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-region[`quarkus.neptune.aws.region`]## + +`quarkus.neptune."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_NEPTUNE_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-type[`quarkus.neptune.aws.credentials.type`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_section_quarkus-neptune-aws-credentials-default-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-default-provider[Default credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-async-credential-update-enabled[`quarkus.neptune.aws.credentials.default-provider.async-credential-update-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-reuse-last-provider-enabled[`quarkus.neptune.aws.credentials.default-provider.reuse-last-provider-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-static-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-static-provider[Static credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-access-key-id]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-access-key-id[`quarkus.neptune.aws.credentials.static-provider.access-key-id`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-secret-access-key]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-secret-access-key[`quarkus.neptune.aws.credentials.static-provider.secret-access-key`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-session-token]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-session-token[`quarkus.neptune.aws.credentials.static-provider.session-token`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-profile-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-profile-provider[AWS Profile credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-profile-provider-profile-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-profile-provider-profile-name[`quarkus.neptune.aws.credentials.profile-provider.profile-name`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-process-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-process-provider[Process credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-async-credential-update-enabled[`quarkus.neptune.aws.credentials.process-provider.async-credential-update-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-credential-refresh-threshold[`quarkus.neptune.aws.credentials.process-provider.credential-refresh-threshold`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-process-output-limit]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-process-output-limit[`quarkus.neptune.aws.credentials.process-provider.process-output-limit`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-command]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-command[`quarkus.neptune.aws.credentials.process-provider.command`]## + +`quarkus.neptune."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. Command and parameters are seperated list entries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-custom-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-custom-provider[Custom credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-custom-provider-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-custom-provider-name[`quarkus.neptune.aws.credentials.custom-provider.name`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client[Sync HTTP transport configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-connection-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-socket-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-socket-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client-apache]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client-apache[Apache HTTP client specific configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-acquisition-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-time-to-live[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-max-connections]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-max-connections[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-expect-continue-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-expect-continue-enabled[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-use-idle-connection-reaper[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-tcp-keep-alive[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-enabled[`quarkus.neptune.sync-client.apache.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-apache-proxy-username]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-username[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-password[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-domain]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-domain[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-workstation[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-preemptive-basic-authentication-enabled[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-non-proxy-hosts[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client-crt]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client-crt[AWS CRT-based HTTP client specific configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-max-concurrency]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-max-concurrency[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-enabled[`quarkus.neptune.sync-client.crt.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-crt-proxy-username]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-username[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-password[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-async-client]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-async-client[Async HTTP transport configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-max-concurrency]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-max-concurrency[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-max-pending-connection-acquires]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-max-pending-connection-acquires[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-read-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-read-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-write-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-write-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-acquisition-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-time-to-live[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-use-idle-connection-reaper[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tcp-keep-alive[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-protocol]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-protocol[`quarkus.neptune.async-client.protocol`]## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|`http1-1`, `http2` +|`http1-1` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-ssl-provider]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-ssl-provider[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`jdk`, `openssl`, `openssl-refcnt` +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-max-streams]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-max-streams[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-initial-window-size]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-initial-window-size[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-health-check-ping-period]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-health-check-ping-period[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-enabled[`quarkus.neptune.async-client.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-async-client-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-non-proxy-hosts[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`none`, `system-property`, `file-store` +|`system-property` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_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-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-override]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-override[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-number-of-threads]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-number-of-threads[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-thread-name-prefix]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-thread-name-prefix[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-advanced-use-future-completion-thread-pool[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_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-neptune_quarkus-neptune] +.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-neptune_quarkus-neptune] +.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[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune_quarkus.neptune.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune_quarkus.neptune.adoc new file mode 100644 index 00000000..8381a70c --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-neptune_quarkus.neptune.adoc @@ -0,0 +1,1748 @@ +[.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-neptune_quarkus-neptune-interceptors]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-interceptors[`quarkus.neptune.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_NEPTUNE_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-telemetry-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-telemetry-enabled[`quarkus.neptune.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_NEPTUNE_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-sync-client-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`url`, `apache`, `aws-crt` +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-async-client-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`netty`, `aws-crt` +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-enabled[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-shared]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-shared[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-isolated]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-isolated[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-service-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-service-name[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-neptune_quarkus-neptune-devservices-container-properties-container-properties]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-devservices-container-properties-container-properties[`quarkus.neptune.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_NEPTUNE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +h|[[quarkus-amazon-neptune_section_quarkus-neptune]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune[AWS SDK client configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-endpoint-override]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-endpoint-override[`quarkus.neptune.endpoint-override`]## + +`quarkus.neptune."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_NEPTUNE_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-api-call-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-api-call-timeout[`quarkus.neptune.api-call-timeout`]## + +`quarkus.neptune."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_NEPTUNE_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-api-call-attempt-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-api-call-attempt-timeout[`quarkus.neptune.api-call-attempt-timeout`]## + +`quarkus.neptune."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_NEPTUNE_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-advanced-use-quarkus-scheduled-executor-service[`quarkus.neptune.advanced.use-quarkus-scheduled-executor-service`]## + +`quarkus.neptune."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_NEPTUNE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws[AWS services configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-region]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-region[`quarkus.neptune.aws.region`]## + +`quarkus.neptune."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_NEPTUNE_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-type[`quarkus.neptune.aws.credentials.type`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_section_quarkus-neptune-aws-credentials-default-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-default-provider[Default credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-async-credential-update-enabled[`quarkus.neptune.aws.credentials.default-provider.async-credential-update-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-default-provider-reuse-last-provider-enabled[`quarkus.neptune.aws.credentials.default-provider.reuse-last-provider-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-static-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-static-provider[Static credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-access-key-id]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-access-key-id[`quarkus.neptune.aws.credentials.static-provider.access-key-id`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-secret-access-key]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-secret-access-key[`quarkus.neptune.aws.credentials.static-provider.secret-access-key`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-session-token]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-static-provider-session-token[`quarkus.neptune.aws.credentials.static-provider.session-token`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-profile-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-profile-provider[AWS Profile credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-profile-provider-profile-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-profile-provider-profile-name[`quarkus.neptune.aws.credentials.profile-provider.profile-name`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-process-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-process-provider[Process credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-async-credential-update-enabled[`quarkus.neptune.aws.credentials.process-provider.async-credential-update-enabled`]## + +`quarkus.neptune."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_NEPTUNE_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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-credential-refresh-threshold[`quarkus.neptune.aws.credentials.process-provider.credential-refresh-threshold`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-process-output-limit]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-process-output-limit[`quarkus.neptune.aws.credentials.process-provider.process-output-limit`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-command]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-process-provider-command[`quarkus.neptune.aws.credentials.process-provider.command`]## + +`quarkus.neptune."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. Command and parameters are seperated list entries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-custom-provider]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-aws-credentials-custom-provider[Custom credentials provider configuration]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-aws-credentials-custom-provider-name]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-aws-credentials-custom-provider-name[`quarkus.neptune.aws.credentials.custom-provider.name`]## + +`quarkus.neptune."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_NEPTUNE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client[Sync HTTP transport configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-connection-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-socket-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-socket-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-key-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-type[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-tls-trust-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client-apache]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client-apache[Apache HTTP client specific configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-acquisition-timeout[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-connection-time-to-live[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-max-connections]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-max-connections[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-expect-continue-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-expect-continue-enabled[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-use-idle-connection-reaper[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-tcp-keep-alive[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-enabled[`quarkus.neptune.sync-client.apache.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-apache-proxy-username]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-username[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-password[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-domain]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-domain[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-ntlm-workstation[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-preemptive-basic-authentication-enabled[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-apache-proxy-non-proxy-hosts[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-sync-client-crt]] [.section-name.section-level1]##link:#quarkus-amazon-neptune_section_quarkus-neptune-sync-client-crt[AWS CRT-based HTTP client specific configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-max-concurrency]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-max-concurrency[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-enabled[`quarkus.neptune.sync-client.crt.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-sync-client-crt-proxy-username]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-username[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-sync-client-crt-proxy-password[`quarkus.neptune.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_NEPTUNE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + + +h|[[quarkus-amazon-neptune_section_quarkus-neptune-async-client]] [.section-name.section-level0]##link:#quarkus-amazon-neptune_section_quarkus-neptune-async-client[Async HTTP transport configurations]## +h|Type +h|Default + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-max-concurrency]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-max-concurrency[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-max-pending-connection-acquires]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-max-pending-connection-acquires[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-read-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-read-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-write-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-write-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-acquisition-timeout[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-time-to-live[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-connection-max-idle-time[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-use-idle-connection-reaper[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tcp-keep-alive[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-protocol]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-protocol[`quarkus.neptune.async-client.protocol`]## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|`http1-1`, `http2` +|`http1-1` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-ssl-provider]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-ssl-provider[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`jdk`, `openssl`, `openssl-refcnt` +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-max-streams]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-max-streams[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-initial-window-size]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-initial-window-size[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-http2-health-check-ping-period]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-http2-health-check-ping-period[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-quarkus-amazon-neptune_quarkus-neptune[icon:question-circle[title=More information about the Duration format]] +|`5` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-enabled]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-enabled[`quarkus.neptune.async-client.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-endpoint[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_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-neptune_quarkus-neptune-async-client-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-proxy-non-proxy-hosts[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`none`, `system-property`, `file-store` +|`system-property` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-key-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-type[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_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-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-path[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-type[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-tls-trust-managers-provider-file-store-password[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-override]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-override[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-number-of-threads]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-number-of-threads[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-thread-name-prefix]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-event-loop-thread-name-prefix[`quarkus.neptune.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_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_NEPTUNE_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a| [[quarkus-amazon-neptune_quarkus-neptune-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##link:#quarkus-amazon-neptune_quarkus-neptune-async-client-advanced-use-future-completion-thread-pool[`quarkus.neptune.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_NEPTUNE_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_NEPTUNE_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-neptune_quarkus-neptune] +.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-neptune_quarkus-neptune] +.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[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptography_quarkus.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptography_quarkus.adoc new file mode 100644 index 00000000..e8ecf815 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptography_quarkus.adoc @@ -0,0 +1,1748 @@ +[.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-paymentcryptography_quarkus-interceptors]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-interceptors[`quarkus.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_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-telemetry-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-telemetry-enabled[`quarkus.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_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-type[`quarkus.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_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`apache`, `aws-crt`, `url` +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-type[`quarkus.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_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`aws-crt`, `netty` +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-devservices-container-properties-container-properties]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-devservices-container-properties-container-properties[`quarkus.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_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-devservices-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-devservices-enabled[`quarkus.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_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-devservices-isolated]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-devservices-isolated[`quarkus.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_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-devservices-service-name]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-devservices-service-name[`quarkus.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_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-devservices-shared]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-devservices-shared[`quarkus.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_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws[AWS services configurations]## +h|Type +h|Default + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-custom-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-custom-provider[Custom credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-custom-provider-name]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-custom-provider-name[`quarkus.aws.credentials.custom-provider.name`]## + +`quarkus."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_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-default-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-default-provider[Default credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-default-provider-async-credential-update-enabled[`quarkus.aws.credentials.default-provider.async-credential-update-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-default-provider-reuse-last-provider-enabled[`quarkus.aws.credentials.default-provider.reuse-last-provider-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-process-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-process-provider[Process credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-async-credential-update-enabled[`quarkus.aws.credentials.process-provider.async-credential-update-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-command]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-command[`quarkus.aws.credentials.process-provider.command`]## + +`quarkus."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. Command and parameters are seperated list entries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-credential-refresh-threshold[`quarkus.aws.credentials.process-provider.credential-refresh-threshold`]## + +`quarkus."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_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-process-output-limit]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-process-provider-process-output-limit[`quarkus.aws.credentials.process-provider.process-output-limit`]## + +`quarkus."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_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-profile-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-profile-provider[AWS Profile credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-profile-provider-profile-name]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-profile-provider-profile-name[`quarkus.aws.credentials.profile-provider.profile-name`]## + +`quarkus."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_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-static-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-aws-credentials-static-provider[Static credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-access-key-id]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-access-key-id[`quarkus.aws.credentials.static-provider.access-key-id`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-secret-access-key]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-secret-access-key[`quarkus.aws.credentials.static-provider.secret-access-key`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-session-token]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-static-provider-session-token[`quarkus.aws.credentials.static-provider.session-token`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-credentials-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-credentials-type[`quarkus.aws.credentials.type`]## + +`quarkus."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_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`anonymous`, `container`, `custom`, `default`, `env-variable`, `instance-profile`, `process`, `profile`, `static`, `system-property` +|`default` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-aws-region]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-aws-region[`quarkus.aws.region`]## + +`quarkus."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_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptography_section_quarkus[AWS SDK client configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-advanced-use-quarkus-scheduled-executor-service[`quarkus.advanced.use-quarkus-scheduled-executor-service`]## + +`quarkus."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_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-api-call-attempt-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-api-call-attempt-timeout[`quarkus.api-call-attempt-timeout`]## + +`quarkus."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_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-api-call-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-api-call-timeout[`quarkus.api-call-timeout`]## + +`quarkus."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_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-endpoint-override]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-endpoint-override[`quarkus.endpoint-override`]## + +`quarkus."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_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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] +| + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-sync-client]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptography_section_quarkus-sync-client[Sync HTTP transport configurations]## +h|Type +h|Default + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-sync-client-apache]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-sync-client-apache[Apache HTTP client specific configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-acquisition-timeout[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-max-idle-time[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-connection-time-to-live[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-expect-continue-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-expect-continue-enabled[`quarkus.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_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-max-connections]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-max-connections[`quarkus.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_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-enabled[`quarkus.sync-client.apache.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-endpoint[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-non-proxy-hosts[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-ntlm-domain]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-ntlm-domain[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-ntlm-workstation[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-password[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-preemptive-basic-authentication-enabled[`quarkus.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_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_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-username]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-proxy-username[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-tcp-keep-alive[`quarkus.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_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-apache-use-idle-connection-reaper[`quarkus.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_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-connection-timeout[`quarkus.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_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`2S` + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-sync-client-crt]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptography_section_quarkus-sync-client-crt[AWS CRT-based HTTP client specific configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-connection-max-idle-time[`quarkus.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_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-max-concurrency]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-max-concurrency[`quarkus.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_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-enabled[`quarkus.sync-client.crt.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-endpoint[`quarkus.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_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-password[`quarkus.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_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-username]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-crt-proxy-username[`quarkus.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_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-socket-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-socket-timeout[`quarkus.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_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-password[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-path[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-file-store-type[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-key-managers-provider-type[`quarkus.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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `none`, `system-property` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-password[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-path[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-file-store-type[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-sync-client-tls-trust-managers-provider-type[`quarkus.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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `system-property`, `trust-all` +|`system-property` + + +h|[[quarkus-amazon-paymentcryptography_section_quarkus-async-client]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptography_section_quarkus-async-client[Async HTTP transport configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-advanced-use-future-completion-thread-pool[`quarkus.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_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_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-connection-acquisition-timeout[`quarkus.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_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-connection-max-idle-time[`quarkus.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_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-connection-time-to-live[`quarkus.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_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-connection-timeout[`quarkus.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_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-number-of-threads]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-number-of-threads[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-override]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-override[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-thread-name-prefix]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-event-loop-thread-name-prefix[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-http2-health-check-ping-period]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-http2-health-check-ping-period[`quarkus.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_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`5` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-http2-initial-window-size]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-http2-initial-window-size[`quarkus.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_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-http2-max-streams]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-http2-max-streams[`quarkus.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_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-max-concurrency]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-max-concurrency[`quarkus.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_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-max-pending-connection-acquires]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-max-pending-connection-acquires[`quarkus.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_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-protocol]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-protocol[`quarkus.async-client.protocol`]## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|`http1-1`, `http2` +|`http1-1` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-enabled[`quarkus.async-client.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-endpoint[`quarkus.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_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-proxy-non-proxy-hosts[`quarkus.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_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-read-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-read-timeout[`quarkus.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_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-ssl-provider]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-ssl-provider[`quarkus.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_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`jdk`, `openssl`, `openssl-refcnt` +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tcp-keep-alive[`quarkus.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_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-password[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-path[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-file-store-type[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-key-managers-provider-type[`quarkus.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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `none`, `system-property` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-password[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-path[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-file-store-type[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-tls-trust-managers-provider-type[`quarkus.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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `system-property`, `trust-all` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-use-idle-connection-reaper[`quarkus.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_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptography_quarkus-async-client-write-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptography_quarkus-async-client-write-timeout[`quarkus.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_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptography_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-paymentcryptography_quarkus] +.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-paymentcryptography_quarkus] +.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[] diff --git a/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptographydata_quarkus.adoc b/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptographydata_quarkus.adoc new file mode 100644 index 00000000..a5569347 --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-amazon-paymentcryptographydata_quarkus.adoc @@ -0,0 +1,1748 @@ +[.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-paymentcryptographydata_quarkus-interceptors]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-interceptors[`quarkus.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_INTERCEPTORS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_INTERCEPTORS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-telemetry-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-telemetry-enabled[`quarkus.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_TELEMETRY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_TELEMETRY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-type[`quarkus.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_SYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`apache`, `aws-crt`, `url` +|`url` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-type[`quarkus.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_ASYNC_CLIENT_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`aws-crt`, `netty` +|`netty` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-devservices-container-properties-container-properties]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-devservices-container-properties-container-properties[`quarkus.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_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_+++` +endif::add-copy-button-to-env-var[] +-- +|Map +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-devservices-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-devservices-enabled[`quarkus.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_DEVSERVICES_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-devservices-isolated]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-devservices-isolated[`quarkus.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_DEVSERVICES_ISOLATED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_ISOLATED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-devservices-service-name]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-devservices-service-name[`quarkus.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_DEVSERVICES_SERVICE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_SERVICE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +|`localstack` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-devservices-shared]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-devservices-shared[`quarkus.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_DEVSERVICES_SHARED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_DEVSERVICES_SHARED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws[AWS services configurations]## +h|Type +h|Default + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-custom-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-custom-provider[Custom credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-custom-provider-name]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-custom-provider-name[`quarkus.aws.credentials.custom-provider.name`]## + +`quarkus."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_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-default-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-default-provider[Default credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-default-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-default-provider-async-credential-update-enabled[`quarkus.aws.credentials.default-provider.async-credential-update-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-default-provider-reuse-last-provider-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-default-provider-reuse-last-provider-enabled[`quarkus.aws.credentials.default-provider.reuse-last-provider-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-process-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-process-provider[Process credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-async-credential-update-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-async-credential-update-enabled[`quarkus.aws.credentials.process-provider.async-credential-update-enabled`]## + +`quarkus."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_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_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-command]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-command[`quarkus.aws.credentials.process-provider.command`]## + +`quarkus."client-name".aws.credentials.process-provider.command` + +[.description] +-- +The command that should be executed to retrieve credentials. Command and parameters are seperated list entries. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-credential-refresh-threshold]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-credential-refresh-threshold[`quarkus.aws.credentials.process-provider.credential-refresh-threshold`]## + +`quarkus."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_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`15S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-process-output-limit]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-process-provider-process-output-limit[`quarkus.aws.credentials.process-provider.process-output-limit`]## + +`quarkus."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_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT+++` +endif::add-copy-button-to-env-var[] +-- +|MemorySize link:#memory-size-note-anchor-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the MemorySize format]] +|`1024` + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-profile-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-profile-provider[AWS Profile credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-profile-provider-profile-name]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-profile-provider-profile-name[`quarkus.aws.credentials.profile-provider.profile-name`]## + +`quarkus."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_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-static-provider]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-aws-credentials-static-provider[Static credentials provider configuration]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-access-key-id]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-access-key-id[`quarkus.aws.credentials.static-provider.access-key-id`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-secret-access-key]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-secret-access-key[`quarkus.aws.credentials.static-provider.secret-access-key`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-session-token]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-static-provider-session-token[`quarkus.aws.credentials.static-provider.session-token`]## + +`quarkus."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_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-credentials-type[`quarkus.aws.credentials.type`]## + +`quarkus."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_AWS_CREDENTIALS_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_CREDENTIALS_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`anonymous`, `container`, `custom`, `default`, `env-variable`, `instance-profile`, `process`, `profile`, `static`, `system-property` +|`default` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-aws-region]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-aws-region[`quarkus.aws.region`]## + +`quarkus."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_AWS_REGION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_AWS_REGION+++` +endif::add-copy-button-to-env-var[] +-- +|Region +| + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus[AWS SDK client configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-advanced-use-quarkus-scheduled-executor-service]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-advanced-use-quarkus-scheduled-executor-service[`quarkus.advanced.use-quarkus-scheduled-executor-service`]## + +`quarkus."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_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-api-call-attempt-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-api-call-attempt-timeout[`quarkus.api-call-attempt-timeout`]## + +`quarkus."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_API_CALL_ATTEMPT_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-api-call-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-api-call-timeout[`quarkus.api-call-timeout`]## + +`quarkus."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_API_CALL_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-endpoint-override]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-endpoint-override[`quarkus.endpoint-override`]## + +`quarkus."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_ENDPOINT_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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] +| + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client[Sync HTTP transport configurations]## +h|Type +h|Default + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client-apache]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client-apache[Apache HTTP client specific configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-acquisition-timeout[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-max-idle-time[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-connection-time-to-live[`quarkus.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_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-expect-continue-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-expect-continue-enabled[`quarkus.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_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-max-connections]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-max-connections[`quarkus.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_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-enabled[`quarkus.sync-client.apache.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-endpoint[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-non-proxy-hosts[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-ntlm-domain]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-ntlm-domain[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-ntlm-workstation]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-ntlm-workstation[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-password[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-preemptive-basic-authentication-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-preemptive-basic-authentication-enabled[`quarkus.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_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_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-username]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-proxy-username[`quarkus.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_SYNC_CLIENT_APACHE_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-tcp-keep-alive[`quarkus.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_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-apache-use-idle-connection-reaper[`quarkus.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_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-connection-timeout[`quarkus.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_SYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`2S` + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client-crt]] [.section-name.section-level1]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-sync-client-crt[AWS CRT-based HTTP client specific configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-connection-max-idle-time[`quarkus.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_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`60S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-max-concurrency]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-max-concurrency[`quarkus.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_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-enabled[`quarkus.sync-client.crt.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_SYNC_CLIENT_CRT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-endpoint[`quarkus.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_SYNC_CLIENT_CRT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-password[`quarkus.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_SYNC_CLIENT_CRT_PROXY_PASSWORD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-username]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-crt-proxy-username[`quarkus.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_SYNC_CLIENT_CRT_PROXY_USERNAME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_CRT_PROXY_USERNAME+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-socket-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-socket-timeout[`quarkus.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_SYNC_CLIENT_SOCKET_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-password[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-path[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-file-store-type[`quarkus.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_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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-key-managers-provider-type[`quarkus.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_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `none`, `system-property` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-password[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-path[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-file-store-type[`quarkus.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_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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-sync-client-tls-trust-managers-provider-type[`quarkus.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_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `system-property`, `trust-all` +|`system-property` + + +h|[[quarkus-amazon-paymentcryptographydata_section_quarkus-async-client]] [.section-name.section-level0]##link:#quarkus-amazon-paymentcryptographydata_section_quarkus-async-client[Async HTTP transport configurations]## +h|Type +h|Default + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-advanced-use-future-completion-thread-pool]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-advanced-use-future-completion-thread-pool[`quarkus.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_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_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-acquisition-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-acquisition-timeout[`quarkus.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_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`2S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-max-idle-time]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-max-idle-time[`quarkus.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_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`5S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-time-to-live]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-time-to-live[`quarkus.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_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-connection-timeout[`quarkus.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_ASYNC_CLIENT_CONNECTION_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`10S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-number-of-threads]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-number-of-threads[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS+++` +endif::add-copy-button-to-env-var[] +-- +|int +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-override]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-override[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-thread-name-prefix]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-event-loop-thread-name-prefix[`quarkus.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_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-health-check-ping-period]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-health-check-ping-period[`quarkus.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_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`5` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-initial-window-size]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-initial-window-size[`quarkus.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_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`1048576` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-max-streams]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-http2-max-streams[`quarkus.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_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_HTTP2_MAX_STREAMS+++` +endif::add-copy-button-to-env-var[] +-- +|long +|`4294967295` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-max-concurrency]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-max-concurrency[`quarkus.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_ASYNC_CLIENT_MAX_CONCURRENCY+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_MAX_CONCURRENCY+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`50` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-max-pending-connection-acquires]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-max-pending-connection-acquires[`quarkus.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_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES+++` +endif::add-copy-button-to-env-var[] +-- +|int +|`10000` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-protocol]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-protocol[`quarkus.async-client.protocol`]## + +[.description] +-- +The HTTP protocol to use. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ASYNC_CLIENT_PROTOCOL+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROTOCOL+++` +endif::add-copy-button-to-env-var[] +-- +a|`http1-1`, `http2` +|`http1-1` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-enabled]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-enabled[`quarkus.async-client.proxy.enabled`]## + +[.description] +-- +Enable HTTP proxy. + + +ifdef::add-copy-button-to-env-var[] +Environment variable: env_var_with_copy_button:+++QUARKUS_ASYNC_CLIENT_PROXY_ENABLED+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROXY_ENABLED+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-endpoint]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-endpoint[`quarkus.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_ASYNC_CLIENT_PROXY_ENDPOINT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-non-proxy-hosts]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-proxy-non-proxy-hosts[`quarkus.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_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS+++` +endif::add-copy-button-to-env-var[] +-- +|list of string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-read-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-read-timeout[`quarkus.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_ASYNC_CLIENT_READ_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-ssl-provider]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-ssl-provider[`quarkus.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_ASYNC_CLIENT_SSL_PROVIDER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_SSL_PROVIDER+++` +endif::add-copy-button-to-env-var[] +-- +a|`jdk`, `openssl`, `openssl-refcnt` +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tcp-keep-alive]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tcp-keep-alive[`quarkus.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_ASYNC_CLIENT_TCP_KEEP_ALIVE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TCP_KEEP_ALIVE+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`false` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-password[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-path[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-file-store-type[`quarkus.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_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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-key-managers-provider-type[`quarkus.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_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `none`, `system-property` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-password]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-password[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-path]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-path[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH+++` +endif::add-copy-button-to-env-var[] +-- +|path +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-file-store-type[`quarkus.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_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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +|string +| + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-type]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-tls-trust-managers-provider-type[`quarkus.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_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE+++` +endif::add-copy-button-to-env-var[] +-- +a|`file-store`, `system-property`, `trust-all` +|`system-property` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-use-idle-connection-reaper]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-use-idle-connection-reaper[`quarkus.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_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER+++` +endif::add-copy-button-to-env-var[] +-- +|boolean +|`true` + +a|icon:lock[title=Fixed at build time] [[quarkus-amazon-paymentcryptographydata_quarkus-async-client-write-timeout]] [.property-path]##link:#quarkus-amazon-paymentcryptographydata_quarkus-async-client-write-timeout[`quarkus.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_ASYNC_CLIENT_WRITE_TIMEOUT+++[] +endif::add-copy-button-to-env-var[] +ifndef::add-copy-button-to-env-var[] +Environment variable: `+++QUARKUS_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-quarkus-amazon-paymentcryptographydata_quarkus[icon:question-circle[title=More information about the Duration format]] +|`30S` + + +|=== + +ifndef::no-duration-note[] +[NOTE] +[id=duration-note-anchor-quarkus-amazon-paymentcryptographydata_quarkus] +.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-paymentcryptographydata_quarkus] +.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[] diff --git a/integration-tests/src/main/java/io/quarkiverse/it/amazon/acm/AcmResource.java b/integration-tests/src/main/java/io/quarkiverse/it/amazon/acm/AcmResource.java index 6baf54f4..c8b4406c 100644 --- a/integration-tests/src/main/java/io/quarkiverse/it/amazon/acm/AcmResource.java +++ b/integration-tests/src/main/java/io/quarkiverse/it/amazon/acm/AcmResource.java @@ -1,20 +1,22 @@ package io.quarkiverse.it.amazon.acm; +import static jakarta.ws.rs.core.MediaType.TEXT_PLAIN; + +import java.util.concurrent.CompletionStage; + import jakarta.inject.Inject; import jakarta.ws.rs.GET; import jakarta.ws.rs.Path; import jakarta.ws.rs.Produces; + import org.jboss.logging.Logger; + import software.amazon.awssdk.services.acm.AcmAsyncClient; import software.amazon.awssdk.services.acm.AcmClient; import software.amazon.awssdk.services.acm.model.CertificateDetail; import software.amazon.awssdk.services.acm.model.DescribeCertificateResponse; import software.amazon.awssdk.services.acm.model.RequestCertificateResponse; -import java.util.concurrent.CompletionStage; - -import static jakarta.ws.rs.core.MediaType.TEXT_PLAIN; - @Path("/acm") public class AcmResource { diff --git a/integration-tests/src/test/java/io/quarkiverse/it/amazon/AmazonAcmTest.java b/integration-tests/src/test/java/io/quarkiverse/it/amazon/AmazonAcmTest.java index 4da1bc98..a6dd39ae 100644 --- a/integration-tests/src/test/java/io/quarkiverse/it/amazon/AmazonAcmTest.java +++ b/integration-tests/src/test/java/io/quarkiverse/it/amazon/AmazonAcmTest.java @@ -1,10 +1,11 @@ package io.quarkiverse.it.amazon; -import io.quarkus.test.junit.QuarkusTest; -import io.restassured.RestAssured; +import static org.hamcrest.Matchers.is; + import org.junit.jupiter.api.Test; -import static org.hamcrest.Matchers.is; +import io.quarkus.test.junit.QuarkusTest; +import io.restassured.RestAssured; @QuarkusTest public class AmazonAcmTest { diff --git a/neptune/deployment/pom.xml b/neptune/deployment/pom.xml new file mode 100644 index 00000000..fc83cce2 --- /dev/null +++ b/neptune/deployment/pom.xml @@ -0,0 +1,83 @@ + + + 4.0.0 + + + io.quarkiverse.amazonservices + quarkus-amazon-neptune-parent + 999-SNAPSHOT + + + quarkus-amazon-neptune-deployment + Quarkus - Amazon Services - Neptune - Deployment + + + + io.quarkus + quarkus-core-deployment + + + io.quarkus + quarkus-arc-deployment + + + io.quarkiverse.amazonservices + quarkus-amazon-common-deployment + + + io.quarkiverse.amazonservices + quarkus-amazon-neptune + + + + + io.quarkus + quarkus-junit5-internal + test + + + io.rest-assured + rest-assured + test + + + software.amazon.awssdk + netty-nio-client + test + + + + io.quarkiverse.amazonservices + quarkus-amazon-netty-client-internal-deployment + test + + + software.amazon.awssdk + aws-crt-client + test + + + software.amazon.awssdk + url-connection-client + test + + + + + + + maven-compiler-plugin + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + + + + + + diff --git a/neptune/deployment/src/main/java/io/quarkiverse/amazon/neptune/deployment/NeptuneProcessor.java b/neptune/deployment/src/main/java/io/quarkiverse/amazon/neptune/deployment/NeptuneProcessor.java new file mode 100644 index 00000000..47703a8f --- /dev/null +++ b/neptune/deployment/src/main/java/io/quarkiverse/amazon/neptune/deployment/NeptuneProcessor.java @@ -0,0 +1,211 @@ +package io.quarkiverse.amazon.neptune.deployment; + +import java.util.List; + +import org.jboss.jandex.DotName; + +import io.quarkiverse.amazon.common.deployment.AbstractAmazonServiceProcessor; +import io.quarkiverse.amazon.common.deployment.AmazonClientAsyncResultBuildItem; +import io.quarkiverse.amazon.common.deployment.AmazonClientAsyncTransportBuildItem; +import io.quarkiverse.amazon.common.deployment.AmazonClientInterceptorsPathBuildItem; +import io.quarkiverse.amazon.common.deployment.AmazonClientSyncResultBuildItem; +import io.quarkiverse.amazon.common.deployment.AmazonClientSyncTransportBuildItem; +import io.quarkiverse.amazon.common.deployment.AmazonHttpClients; +import io.quarkiverse.amazon.common.deployment.RequireAmazonClientBuildItem; +import io.quarkiverse.amazon.common.deployment.RequireAmazonClientInjectionBuildItem; +import io.quarkiverse.amazon.common.deployment.RequireAmazonClientTransportBuilderBuildItem; +import io.quarkiverse.amazon.common.deployment.RequireAmazonTelemetryBuildItem; +import io.quarkiverse.amazon.common.deployment.spi.EventLoopGroupBuildItem; +import io.quarkiverse.amazon.common.runtime.AmazonClientApacheTransportRecorder; +import io.quarkiverse.amazon.common.runtime.AmazonClientAwsCrtTransportRecorder; +import io.quarkiverse.amazon.common.runtime.AmazonClientCommonRecorder; +import io.quarkiverse.amazon.common.runtime.AmazonClientNettyTransportRecorder; +import io.quarkiverse.amazon.common.runtime.AmazonClientOpenTelemetryRecorder; +import io.quarkiverse.amazon.common.runtime.AmazonClientUrlConnectionTransportRecorder; +import io.quarkiverse.amazon.neptune.runtime.NeptuneBuildTimeConfig; +import io.quarkiverse.amazon.neptune.runtime.NeptuneRecorder; +import io.quarkus.arc.deployment.BeanRegistrationPhaseBuildItem; +import io.quarkus.arc.deployment.SyntheticBeanBuildItem; +import io.quarkus.deployment.annotations.BuildProducer; +import io.quarkus.deployment.annotations.BuildStep; +import io.quarkus.deployment.annotations.ExecutionTime; +import io.quarkus.deployment.annotations.Record; +import io.quarkus.deployment.builditem.ExecutorBuildItem; +import io.quarkus.deployment.builditem.ExtensionSslNativeSupportBuildItem; +import io.quarkus.deployment.builditem.FeatureBuildItem; +import io.quarkus.deployment.builditem.LaunchModeBuildItem; +import software.amazon.awssdk.services.neptune.NeptuneAsyncClient; +import software.amazon.awssdk.services.neptune.NeptuneAsyncClientBuilder; +import software.amazon.awssdk.services.neptune.NeptuneClient; +import software.amazon.awssdk.services.neptune.NeptuneClientBuilder; + +public class NeptuneProcessor extends AbstractAmazonServiceProcessor { + + private static final String AMAZON_CLIENT_NAME = "amazon-sdk-neptune"; + + NeptuneBuildTimeConfig buildTimeConfig; + + @Override + protected String amazonServiceClientName() { + return AMAZON_CLIENT_NAME; + } + + @Override + protected String configName() { + return "neptune"; + } + + @Override + protected DotName syncClientName() { + return DotName.createSimple(NeptuneClient.class.getName()); + } + + @Override + protected DotName asyncClientName() { + return DotName.createSimple(NeptuneAsyncClient.class.getName()); + } + + @Override + protected String builtinInterceptorsPath() { + return "software/amazon/awssdk/services/neptune/execution.interceptors"; + } + + @BuildStep + void setup( + BuildProducer extensionSslNativeSupport, + BuildProducer feature, + BuildProducer interceptors) { + + setupExtension(extensionSslNativeSupport, feature, interceptors); + } + + @BuildStep + void discoverClientInjectionPoints(BeanRegistrationPhaseBuildItem beanRegistrationPhase, + BuildProducer requireClientInjectionProducer) { + + discoverClientInjectionPointsInternal(beanRegistrationPhase, requireClientInjectionProducer); + } + + @BuildStep + void discover( + List amazonClientInjectionPoints, + BuildProducer requireClientProducer) { + + discoverClient(amazonClientInjectionPoints, requireClientProducer); + } + + @BuildStep + void discoverTelemetry(BuildProducer telemetryProducer) { + + discoverTelemetry(telemetryProducer, buildTimeConfig.sdk()); + } + + @BuildStep + void setupClient(List clientRequirements, + BuildProducer clientProducer) { + + setupClient(clientRequirements, clientProducer, buildTimeConfig.sdk(), buildTimeConfig.syncClient(), + buildTimeConfig.asyncClient()); + } + + @BuildStep(onlyIf = AmazonHttpClients.IsAmazonApacheHttpServicePresent.class) + @Record(ExecutionTime.RUNTIME_INIT) + void setupApacheSyncTransport(List amazonClients, NeptuneRecorder recorder, + AmazonClientApacheTransportRecorder transportRecorder, + BuildProducer syncTransports) { + + createApacheSyncTransportBuilder(amazonClients, + transportRecorder, + buildTimeConfig.syncClient(), + recorder.getSyncConfig(), + syncTransports); + } + + @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) + @Record(ExecutionTime.RUNTIME_INIT) + void setupAwsCrtSyncTransport(List amazonClients, NeptuneRecorder recorder, + AmazonClientAwsCrtTransportRecorder transportRecorder, + BuildProducer syncTransports) { + + createAwsCrtSyncTransportBuilder(amazonClients, + transportRecorder, + buildTimeConfig.syncClient(), + recorder.getSyncConfig(), + syncTransports); + } + + @BuildStep(onlyIf = AmazonHttpClients.IsAmazonUrlConnectionHttpServicePresent.class) + @Record(ExecutionTime.RUNTIME_INIT) + void setupUrlConnectionSyncTransport(List amazonClients, + NeptuneRecorder recorder, + AmazonClientUrlConnectionTransportRecorder transportRecorder, + BuildProducer syncTransports) { + + createUrlConnectionSyncTransportBuilder(amazonClients, + transportRecorder, + buildTimeConfig.syncClient(), + recorder.getSyncConfig(), + syncTransports); + } + + @BuildStep(onlyIf = AmazonHttpClients.IsAmazonNettyHttpServicePresent.class) + @Record(ExecutionTime.RUNTIME_INIT) + void setupNettyAsyncTransport(List amazonClients, NeptuneRecorder recorder, + AmazonClientNettyTransportRecorder transportRecorder, + BuildProducer asyncTransports, + EventLoopGroupBuildItem eventLoopSupplier) { + + createNettyAsyncTransportBuilder(amazonClients, + transportRecorder, + buildTimeConfig.asyncClient(), + recorder.getAsyncConfig(), + asyncTransports, eventLoopSupplier.getMainEventLoopGroup()); + } + + @BuildStep(onlyIf = AmazonHttpClients.IsAmazonAwsCrtHttpServicePresent.class) + @Record(ExecutionTime.RUNTIME_INIT) + void setupAwsCrtAsyncTransport(List amazonClients, NeptuneRecorder recorder, + AmazonClientAwsCrtTransportRecorder transportRecorder, + BuildProducer asyncTransports) { + + createAwsCrtAsyncTransportBuilder(amazonClients, + transportRecorder, + buildTimeConfig.asyncClient(), + recorder.getAsyncConfig(), + asyncTransports); + } + + @BuildStep + @Record(ExecutionTime.RUNTIME_INIT) + void createClientBuilders(NeptuneRecorder recorder, + AmazonClientCommonRecorder commonRecorder, + AmazonClientOpenTelemetryRecorder otelRecorder, + List amazonClientInjections, + List amazonRequireTelemtryClients, + List syncTransports, + List asyncTransports, + BuildProducer syntheticBeans, + BuildProducer clientSync, + BuildProducer clientAsync, + LaunchModeBuildItem launchModeBuildItem, + ExecutorBuildItem executorBuildItem) { + + createClientBuilders( + recorder, + commonRecorder, + otelRecorder, + buildTimeConfig, + amazonClientInjections, + amazonRequireTelemtryClients, + syncTransports, + asyncTransports, + NeptuneClientBuilder.class, + NeptuneAsyncClientBuilder.class, + null, + syntheticBeans, + clientSync, + clientAsync, + launchModeBuildItem, + executorBuildItem); + } +} diff --git a/neptune/deployment/src/test/java/io/quarkiverse/amazon/neptune/deployment/NeptuneSyncClientFullConfigTest.java b/neptune/deployment/src/test/java/io/quarkiverse/amazon/neptune/deployment/NeptuneSyncClientFullConfigTest.java new file mode 100644 index 00000000..6215d1be --- /dev/null +++ b/neptune/deployment/src/test/java/io/quarkiverse/amazon/neptune/deployment/NeptuneSyncClientFullConfigTest.java @@ -0,0 +1,29 @@ +package io.quarkiverse.amazon.neptune.deployment; + +import jakarta.inject.Inject; + +import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.extension.RegisterExtension; + +import io.quarkus.test.QuarkusUnitTest; +import software.amazon.awssdk.services.neptune.NeptuneAsyncClient; +import software.amazon.awssdk.services.neptune.NeptuneClient; + +public class NeptuneSyncClientFullConfigTest { + + @Inject + NeptuneClient client; + + @Inject + NeptuneAsyncClient async; + + @RegisterExtension + static final QuarkusUnitTest config = new QuarkusUnitTest() + .withApplicationRoot((jar) -> jar + .addAsResource("sync-urlconn-full-config.properties", "application.properties")); + + @Test + public void test() { + // should finish with success + } +} diff --git a/neptune/deployment/src/test/resources/sync-urlconn-full-config.properties b/neptune/deployment/src/test/resources/sync-urlconn-full-config.properties new file mode 100644 index 00000000..9b256df2 --- /dev/null +++ b/neptune/deployment/src/test/resources/sync-urlconn-full-config.properties @@ -0,0 +1,10 @@ +quarkus.neptune.endpoint-override=http://localhost:9090 + +quarkus.neptune.aws.region=us-east-1 +quarkus.neptune.aws.credentials.type=static +quarkus.neptune.aws.credentials.static-provider.access-key-id=test-key +quarkus.neptune.aws.credentials.static-provider.secret-access-key=test-secret + +quarkus.neptune.sync-client.type = url +quarkus.neptune.sync-client.connection-timeout = 0.100S +quarkus.neptune.sync-client.socket-timeout = 0.100S \ No newline at end of file diff --git a/neptune/pom.xml b/neptune/pom.xml new file mode 100644 index 00000000..e00d495a --- /dev/null +++ b/neptune/pom.xml @@ -0,0 +1,21 @@ + + + 4.0.0 + + + io.quarkiverse.amazonservices + quarkus-amazon-services-build-parent + 999-SNAPSHOT + ../build-parent/pom.xml + + + quarkus-amazon-neptune-parent + Quarkus - Amazon Services - Neptune + pom + + + runtime + deployment + + + diff --git a/neptune/runtime/pom.xml b/neptune/runtime/pom.xml new file mode 100644 index 00000000..be8b3f32 --- /dev/null +++ b/neptune/runtime/pom.xml @@ -0,0 +1,99 @@ + + + 4.0.0 + + + io.quarkiverse.amazonservices + quarkus-amazon-neptune-parent + 999-SNAPSHOT + + + quarkus-amazon-neptune + Quarkus - Amazon Services - Neptune - Runtime + Connect to Amazon Neptune + + + + io.quarkus + quarkus-core + + + io.quarkus + quarkus-arc + + + io.quarkiverse.amazonservices + quarkus-amazon-common + + + software.amazon.awssdk + neptune + + + + software.amazon.awssdk + netty-nio-client + + + software.amazon.awssdk + url-connection-client + + + software.amazon.awssdk + apache-client + + + + + software.amazon.awssdk + netty-nio-client + true + + + software.amazon.awssdk + aws-crt-client + true + + + software.amazon.awssdk + url-connection-client + true + + + software.amazon.awssdk + apache-client + true + + + commons-logging + commons-logging + + + + + org.jboss.logging + commons-logging-jboss-logging + + + + + + + io.quarkus + quarkus-extension-maven-plugin + + + maven-compiler-plugin + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + + + + + + diff --git a/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneBuildTimeConfig.java b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneBuildTimeConfig.java new file mode 100644 index 00000000..ad67cb4e --- /dev/null +++ b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneBuildTimeConfig.java @@ -0,0 +1,32 @@ +package io.quarkiverse.amazon.neptune.runtime; + +import io.quarkiverse.amazon.common.runtime.AsyncHttpClientBuildTimeConfig; +import io.quarkiverse.amazon.common.runtime.DevServicesBuildTimeConfig; +import io.quarkiverse.amazon.common.runtime.HasSdkBuildTimeConfig; +import io.quarkiverse.amazon.common.runtime.SyncHttpClientBuildTimeConfig; +import io.quarkus.runtime.annotations.ConfigPhase; +import io.quarkus.runtime.annotations.ConfigRoot; +import io.smallrye.config.ConfigMapping; + +/** + * Amazon Neptune build time configuration + */ +@ConfigMapping(prefix = "quarkus.neptune") +@ConfigRoot(phase = ConfigPhase.BUILD_AND_RUN_TIME_FIXED) +public interface NeptuneBuildTimeConfig extends HasSdkBuildTimeConfig { + + /** + * Sync HTTP transport configuration for Amazon Neptune client + */ + SyncHttpClientBuildTimeConfig syncClient(); + + /** + * Async HTTP transport configuration for Amazon Neptune client + */ + AsyncHttpClientBuildTimeConfig asyncClient(); + + /** + * Config for dev services + */ + DevServicesBuildTimeConfig devservices(); +} diff --git a/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneConfig.java b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneConfig.java new file mode 100644 index 00000000..889ee0c9 --- /dev/null +++ b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneConfig.java @@ -0,0 +1,25 @@ +package io.quarkiverse.amazon.neptune.runtime; + +import io.quarkiverse.amazon.common.runtime.AsyncHttpClientConfig; +import io.quarkiverse.amazon.common.runtime.HasAmazonClientRuntimeConfig; +import io.quarkiverse.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; + +@ConfigMapping(prefix = "quarkus.neptune") +@ConfigRoot(phase = ConfigPhase.RUN_TIME) +public interface NeptuneConfig extends HasAmazonClientRuntimeConfig { + /** + * Sync HTTP transport configurations + */ + @ConfigDocSection + SyncHttpClientConfig syncClient(); + + /** + * Async HTTP transport configurations + */ + @ConfigDocSection + AsyncHttpClientConfig asyncClient(); +} diff --git a/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneRecorder.java b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneRecorder.java new file mode 100644 index 00000000..edb77496 --- /dev/null +++ b/neptune/runtime/src/main/java/io/quarkiverse/amazon/neptune/runtime/NeptuneRecorder.java @@ -0,0 +1,47 @@ +package io.quarkiverse.amazon.neptune.runtime; + +import io.quarkiverse.amazon.common.runtime.AmazonClientRecorder; +import io.quarkiverse.amazon.common.runtime.AsyncHttpClientConfig; +import io.quarkiverse.amazon.common.runtime.HasAmazonClientRuntimeConfig; +import io.quarkiverse.amazon.common.runtime.SyncHttpClientConfig; +import io.quarkus.runtime.RuntimeValue; +import io.quarkus.runtime.annotations.Recorder; +import software.amazon.awssdk.awscore.client.builder.AwsAsyncClientBuilder; +import software.amazon.awssdk.awscore.client.builder.AwsSyncClientBuilder; +import software.amazon.awssdk.services.neptune.NeptuneAsyncClient; +import software.amazon.awssdk.services.neptune.NeptuneClient; + +@Recorder +public class NeptuneRecorder extends AmazonClientRecorder { + + final NeptuneConfig config; + + public NeptuneRecorder(NeptuneConfig config) { + this.config = config; + } + + @Override + public RuntimeValue getAmazonClientsConfig() { + return new RuntimeValue<>(config); + } + + @Override + public AsyncHttpClientConfig getAsyncClientConfig() { + return config.asyncClient(); + } + + @Override + public SyncHttpClientConfig getSyncClientConfig() { + return config.syncClient(); + } + + @Override + public AwsSyncClientBuilder geSyncClientBuilder() { + return NeptuneClient.builder(); + } + + @Override + public AwsAsyncClientBuilder getAsyncClientBuilder() { + return NeptuneAsyncClient.builder(); + } +} diff --git a/neptune/runtime/src/main/resources/META-INF/quarkus-extension.yaml b/neptune/runtime/src/main/resources/META-INF/quarkus-extension.yaml new file mode 100644 index 00000000..a7826ed3 --- /dev/null +++ b/neptune/runtime/src/main/resources/META-INF/quarkus-extension.yaml @@ -0,0 +1,14 @@ +--- +artifact: ${project.groupId}:${project.artifactId}:${project.version} +name: "Amazon Neptune" +metadata: + keywords: + - "neptune" + - "aws" + - "amazon" + categories: + - "data" + guide: https://docs.quarkiverse.io/quarkus-amazon-services/dev/amazon-neptune.html + status: "stable" + config: + - "quarkus.neptune." diff --git a/pom.xml b/pom.xml index 09c72cb4..8e8fe3c5 100644 --- a/pom.xml +++ b/pom.xml @@ -32,6 +32,7 @@ kinesis kms lambda + neptune paymentcryptography paymentcryptographydata s3