Amazon API Gateway Management Api Client

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.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_INTERCEPTORS

OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_TELEMETRY_ENABLED

Type of the sync HTTP client implementation

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TYPE

Type of the async HTTP client implementation

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TYPE

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

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_DEVSERVICES_ENABLED

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.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_DEVSERVICES_SHARED

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, …​)

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_DEVSERVICES_ISOLATED

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.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_DEVSERVICES_SERVICE_NAME

Generic properties that are pass for additional container configuration.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_

The endpoint URI with which the SDK should communicate.

If not specified, an appropriate endpoint to be used for the given service and region.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ENDPOINT_OVERRIDE

The amount of time to allow the client to complete the execution of an API call.

This timeout covers the entire client execution except for marshalling. This includes request handler execution, all HTTP requests including retries, unmarshalling, etc.

This value should always be positive, if present.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_API_CALL_TIMEOUT

The amount of time to wait for the HTTP request to complete before giving up and timing out.

This value should always be positive, if present.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_API_CALL_ATTEMPT_TIMEOUT

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.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE

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:

See software.amazon.awssdk.regions.Region for available regions.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_REGION

Configure the credentials provider that should be used to authenticate with AWS.

Available values:

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_TYPE

Whether this provider should fetch credentials asynchronously in the background.

If this is true, threads are less likely to block, but additional resources are used to maintain the provider.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

Whether the provider should reuse the last successful credentials provider in the chain.

Reusing the last successful credentials provider will typically return credentials faster than searching through the chain.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED

AWS Access key id

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID

AWS Secret access key

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY

AWS Session token

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN

The name of the profile that should be used by this credentials provider.

If not specified, the value in AWS_PROFILE environment variable or aws.profile system property is used and defaults to default name.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME

Whether the provider should fetch credentials asynchronously in the background.

If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

The amount of time between when the credentials expire and when the credentials should start to be refreshed.

This allows the credentials to be refreshed *before* they are reported to expire.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD

The maximum size of the output that can be returned by the external process before an exception is raised.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT

The command that should be executed to retrieve credentials. Command and parameters are seperated list entries.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND

The name of custom AwsCredentialsProvider bean.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME

The maximum amount of time to establish a connection before timing out.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CONNECTION_TIMEOUT

The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_SOCKET_TIMEOUT

TLS key managers provider type.

Available providers:

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE

Path to the key store.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH

Key store type.

See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE

Key store password

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

TLS trust managers provider type.

Available providers:

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE

Path to the key store.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH

Key store type.

See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE

Key store password

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

The amount of time to wait when acquiring a connection from the pool before giving up and timing out.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT

The maximum amount of time that a connection should be allowed to remain open while idle.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME

The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE

The maximum number of connections allowed in the connection pool.

Each built HTTP client has its own private connection pool.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_MAX_CONNECTIONS

Whether the client should send an HTTP expect-continue handshake before each request.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED

Whether the idle connections in the connection pool should be closed asynchronously.

When enabled, connections left idling for longer than quarkus..sync-client.connection-max-idle-time will be closed. This will not close connections currently in use.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER

Configure whether to enable or disable TCP KeepAlive.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE

Enable HTTP proxy

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_ENABLED

The endpoint of the proxy server that the SDK should connect through.

Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_ENDPOINT

The username to use when connecting through a proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_USERNAME

The password to use when connecting through a proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_PASSWORD

For NTLM proxies - the Windows domain name to use when authenticating with the proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN

For NTLM proxies - the Windows workstation name to use when authenticating with the proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION

Whether to attempt to authenticate preemptively against the proxy server using basic authentication.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED

The hosts that the client is allowed to access without going through the proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS

The maximum amount of time that a connection should be allowed to remain open while idle.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME

The maximum number of allowed concurrent requests.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_MAX_CONCURRENCY

Enable HTTP proxy

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_PROXY_ENABLED

The endpoint of the proxy server that the SDK should connect through.

Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_PROXY_ENDPOINT

The username to use when connecting through a proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_PROXY_USERNAME

The password to use when connecting through a proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_SYNC_CLIENT_CRT_PROXY_PASSWORD

The maximum number of allowed concurrent requests.

For HTTP/1.1 this is the same as max connections. For HTTP/2 the number of connections that will be used depends on the max streams allowed per connection.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_MAX_CONCURRENCY

The maximum number of pending acquires allowed.

Once this exceeds, acquire tries will be failed.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES

The amount of time to wait for a read on a socket before an exception is thrown.

Specify 0 to disable.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_READ_TIMEOUT

The amount of time to wait for a write on a socket before an exception is thrown.

Specify 0 to disable.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_WRITE_TIMEOUT

The amount of time to wait when initially establishing a connection before giving up and timing out.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_CONNECTION_TIMEOUT

The amount of time to wait when acquiring a connection from the pool before giving up and timing out.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT

The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE

The maximum amount of time that a connection should be allowed to remain open while idle.

Currently has no effect if quarkus..async-client.use-idle-connection-reaper is false.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME

Whether the idle connections in the connection pool should be closed.

When enabled, connections left idling for longer than quarkus..async-client.connection-max-idle-time will be closed. This will not close connections currently in use.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER

Configure whether to enable or disable TCP KeepAlive.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TCP_KEEP_ALIVE

The HTTP protocol to use.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_PROTOCOL

The SSL Provider to be used in the Netty client.

Default is OPENSSL if available, JDK otherwise.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_SSL_PROVIDER

The maximum number of concurrent streams for an HTTP/2 connection.

This setting is only respected when the HTTP/2 protocol is used.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_HTTP2_MAX_STREAMS

The initial window size for an HTTP/2 stream.

This setting is only respected when the HTTP/2 protocol is used.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE

Sets the period that the Netty client will send PING frames to the remote endpoint to check the health of the connection. To disable this feature, set a duration of 0.

This setting is only respected when the HTTP/2 protocol is used.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD

Enable HTTP proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_PROXY_ENABLED

The endpoint of the proxy server that the SDK should connect through.

Currently, the endpoint is limited to a host and port. Any other URI components will result in an exception being raised.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_PROXY_ENDPOINT

The hosts that the client is allowed to access without going through the proxy.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS

TLS key managers provider type.

Available providers:

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE

Path to the key store.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH

Key store type.

See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE

Key store password

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

TLS trust managers provider type.

Available providers:

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE

Path to the key store.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH

Key store type.

See the KeyStore section in the https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html#KeyStore[Java Cryptography Architecture Standard Algorithm Name Documentation] for information about standard keystore types.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE

Key store password

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

Enable the custom configuration of the Netty event loop group.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE

Number of threads to use for the event loop group.

If not set, the default Netty thread count is used (which is double the number of available processors unless the io.netty.eventLoopThreads system property is set.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS

The thread name prefix for threads created by this thread factory used by event loop group.

The prefix will be appended with a number unique to the thread factory and a number unique to the thread.

If not specified it defaults to aws-java-sdk-NettyEventLoop

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX

Whether the default thread pool should be used to complete the futures returned from the HTTP client request.

When disabled, futures will be completed on the Netty event loop thread.

Environment variable: QUARKUS_APIGATEWAYMANAGEMENTAPI_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL