AWS Resource Groups Tagging API Client
The AWS Resource Groups Tagging API lets you manage the tags of resources across many AWS services from a single place. This client lets you tag and untag resources in bulk, find resources by tag, list the tag keys and values in use, and report on tag policy compliance.
For more information, see the AWS Resource Groups Tagging API documentation.
| The AWS Resource Groups Tagging API extension is based on 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), the Apache 5.x HTTP client, the Apache HTTP client (deprecated) or the AWS CRT-based HTTP client
-
Asynchronous programming based on JDK’s
CompletableFutureobjects and the Netty HTTP client or the AWS CRT-based HTTP client
In this guide, we see how you can get your REST services to use AWS Resource Groups Tagging API locally and on AWS.
Prerequisites
To complete this guide, you need:
-
JDK 21+ installed with
JAVA_HOMEconfigured appropriately -
an IDE
-
Apache Maven 3.8.1+
-
Docker, to run AWS Resource Groups Tagging API locally with Dev Services and to run the tests
-
Optionally, GraalVM or Mandrel installed to build a native executable
No AWS account is required: Dev Services and the local Floci container provide everything you need. You only need an AWS account and the AWS Command Line Interface if you want to deploy to AWS.
Start Floci automatically with Dev Services
The easiest way to start working with AWS Resource Groups Tagging API is to run a local instance using Dev Services. Dev Services starts a Floci container in dev and test modes, and configures the client to use it, so you don’t need an AWS account.
The container listens on a random port, so you never hard-code an endpoint.
It is labelled quarkus-dev-service-floci and shared between the Quarkus applications running in dev mode.
Refer to Dev Services for Amazon Services for the provider selection, the container configuration and the init scripts.
Start Floci manually
You can also start a Floci container yourself:
docker run --rm --name floci --publish 4566:4566 -d floci/floci:latest-compatThis starts a Floci instance that is accessible on port 4566. Floci exposes all the services it emulates on this single endpoint.
The latest-compat image ships the AWS CLI, already configured to target the local endpoint.
Run the provisioning commands of this guide inside the container, with docker exec floci aws ….
You do not need to install or configure the AWS CLI on your host.
You can check the region, the credentials and the endpoint used inside the container:
docker exec floci env | grep AWS_The CLI uses the region us-east-1, the credentials test / test, and the endpoint http://localhost:4566 seen from inside the container.
An application running on the host reaches Floci at http://localhost:4566; an application running in another container must use the container name, for example http://floci:4566, and the containers must share a Docker network.
What you will build
The application built here tags AWS resources, finds them by tag and removes their tags.
It uses the synchronous client first, then the asynchronous client in Going asynchronous.
Walkthrough
Creating the Maven project
First, we need a new project. Create a new project with the following command:
mvn io.quarkus.platform:quarkus-maven-plugin:4.0.0.Beta1:create \
-DprojectGroupId=org.acme \
-DprojectArtifactId=amazon-resourcegroupstaggingapi-quickstart \
-DclassName="org.acme.resourcegroupstaggingapi.QuarkusResourceGroupsTaggingApiSyncResource" \
-Dpath="/sync" \
-Dextensions="rest-jackson,amazon-resourcegroupstaggingapi"
cd amazon-resourcegroupstaggingapi-quickstartThis command generates a Maven structure importing the Quarkus REST and AWS Resource Groups Tagging API Client extensions.
After this, the amazon-resourcegroupstaggingapi extension has been added to your pom.xml, along with quarkus-rest and quarkus-rest-jackson.
The AWS Resource Groups Tagging API extensions are a component of the Quarkus platform, and the generated pom.xml already imports their BOM through it, which is the recommended setup.
Due to differing release schedules, the Quarkus platform may not include the latest Quarkus Amazon Services release.
If you need features from a newer release, replace the generated quarkus-amazon-services-bom import with the Quarkus Amazon Services BOM:
<dependency>
<groupId>io.quarkiverse.amazonservices</groupId>
<artifactId>quarkus-amazon-services-bom</artifactId>
<version>4.0.0.Beta3</version>
<type>pom</type>
<scope>import</scope>
</dependency>The command also generates a QuarkusResourceGroupsTaggingApiSyncResourceTest class and a QuarkusResourceGroupsTaggingApiSyncResourceIT class that call the hello endpoint of the generated resource.
The next section replaces that resource: delete these two files, or update them to match the endpoints you create.
Creating the REST resource
The Resource Groups Tagging API works on resources managed by other AWS services, identified by their ARN, such as the SQS queue that this guide creates.
Let’s create a org.acme.resourcegroupstaggingapi.QuarkusResourceGroupsTaggingApiSyncResource that will provide an API to manage the tags using the synchronous client.
package org.acme.resourcegroupstaggingapi;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import org.jboss.resteasy.reactive.RestQuery;
import software.amazon.awssdk.services.resourcegroupstaggingapi.ResourceGroupsTaggingApiClient;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.FailureInfo;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.ResourceTagMapping;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.TagFilter;
@Path("/sync")
@Produces(MediaType.APPLICATION_JSON)
public class QuarkusResourceGroupsTaggingApiSyncResource {
@Inject
ResourceGroupsTaggingApiClient client;
@POST
@Path("/tag")
public Map<String, String> tag(@RestQuery String arn, @RestQuery String key, @RestQuery String value) {
return errors(client.tagResources(req -> req.resourceARNList(arn).tags(Map.of(key, value)))
.failedResourcesMap());
}
@POST
@Path("/untag")
public Map<String, String> untag(@RestQuery String arn, @RestQuery String key) {
return errors(client.untagResources(req -> req.resourceARNList(arn).tagKeys(key))
.failedResourcesMap());
}
@GET
@Path("/resources")
public List<String> resources(@RestQuery String key, @RestQuery String value) {
return client.getResources(req -> req.tagFilters(tagFilter(key, value)))
.resourceTagMappingList().stream()
.map(ResourceTagMapping::resourceARN)
.toList();
}
@GET
@Path("/tag-keys")
public List<String> tagKeys() {
return client.getTagKeys().tagKeys();
}
@GET
@Path("/tag-values")
public List<String> tagValues(@RestQuery String key) {
return client.getTagValues(req -> req.key(key)).tagValues();
}
static TagFilter tagFilter(String key, String value) {
return value == null
? TagFilter.builder().key(key).build()
: TagFilter.builder().key(key).values(value).build();
}
static Map<String, String> errors(Map<String, FailureInfo> failedResources) {
return failedResources.entrySet().stream()
.collect(Collectors.toMap(Map.Entry::getKey, entry -> entry.getValue().errorMessage()));
}
}The tag and untag endpoints return the resources that could not be updated, with their error message: an empty JSON object means that the operation succeeded.
The resources endpoint returns the ARNs of the resources having the given tag key, and the given value when it is provided.
For brevity, the resources, tag-keys and tag-values endpoints only return the first page of results.
Use the getResourcesPaginator, getTagKeysPaginator and getTagValuesPaginator methods of the client to iterate over all the pages.
|
Configuring AWS Resource Groups Tagging API clients
Both AWS Resource Groups Tagging API clients (sync and async) are configurable via the application.properties file that can be provided in the src/main/resources directory.
Additionally, you need to add to the classpath a proper implementation of the sync client. By default, the extension uses the URL connection HTTP client, so
you need to add a URL connection client dependency to the pom.xml file:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>url-connection-client</artifactId>
</dependency>If you want to use the Apache 5.x HTTP client instead, configure it as follows:
quarkus.resourcegroupstaggingapi.sync-client.type=apache5And add the following dependency to the application pom.xml:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>apache5-client</artifactId>
</dependency>If you want to use the Apache HTTP client instead, configure it as follows:
quarkus.resourcegroupstaggingapi.sync-client.type=apacheAnd add the following dependency to the application pom.xml:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>apache-client</artifactId>
</dependency>|
The AWS SDK has deprecated the Apache HTTP client in favor of the Apache 5.x HTTP client, which is a drop-in replacement: prefer |
If you want to use the AWS CRT-based HTTP client instead, configure it as follows:
quarkus.resourcegroupstaggingapi.sync-client.type=aws-crtAnd add the following dependency to the application pom.xml:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>aws-crt-client</artifactId>
</dependency>Use Dev Services
With Dev Services, there is nothing to configure: in dev and test modes, Dev Services starts Floci and configures the endpoint, the region and the credentials of the clients.
Use a manually started Floci
If you started Floci yourself, configure the client to use it as follows:
quarkus.resourcegroupstaggingapi.endpoint-override=http://localhost:4566 (1)
quarkus.resourcegroupstaggingapi.aws.region=us-east-1 (2)
quarkus.resourcegroupstaggingapi.aws.credentials.type=static (3)
quarkus.resourcegroupstaggingapi.aws.credentials.static-provider.access-key-id=test-key
quarkus.resourcegroupstaggingapi.aws.credentials.static-provider.secret-access-key=test-secret| 1 | Override the AWS Resource Groups Tagging API client to use Floci instead of the actual AWS service. When it is set, Dev Services does not start a local stack for AWS Resource Groups Tagging API. |
| 2 | Floci defaults to us-east-1 |
| 3 | The static credentials provider lets you set the access-key-id and secret-access-key directly |
Use your AWS account
If you want to work with an AWS account, you need an AWS account with access to AWS Resource Groups Tagging API and the AWS Command Line Interface, then remove or comment out the endpoint-override and the static credentials properties of the previous section.
By default, the AWS Resource Groups Tagging API client extension uses the default credentials provider chain that looks for credentials in this order:
-
Java System Properties -
aws.accessKeyIdandaws.secretAccessKey -
Environment Variables -
AWS_ACCESS_KEY_IDandAWS_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 ECS if the
AWS_CONTAINER_CREDENTIALS_RELATIVE_URIenvironment variable is set and the security manager has permission to access the variable, -
Instance profile credentials delivered through the Amazon EC2 metadata service
And the region from your AWS CLI profile will be used.
|
Without Dev Services never starts in production mode. |
Create the resource to tag
The Resource Groups Tagging API manages the tags of resources created by other AWS services.
Create a SQS queue named quarkus-tagging, and store its ARN in the RESOURCE_ARN environment variable, which you will pass to the application.
Dev Services starts Floci with the floci/floci:latest image by default, which does not ship the AWS CLI.
To create the quarkus-tagging queue automatically at startup, use the latest-compat image and provide init scripts:
quarkus.aws.devservices.floci.image-name=floci/floci:latest-compat
quarkus.aws.devservices.floci.init-scripts-classpath=floci-init
quarkus.aws.devservices.floci.init-completion-msg=#### Init completedCreate src/main/resources/floci-init/01_create_queue.sh:
#!/bin/bash
aws sqs create-queue --queue-name quarkus-taggingThen create src/main/resources/floci-init/99_completed.sh, which prints the message Dev Services waits for:
#!/bin/bash
echo "#### Init completed"Dev Services looks up the scripts in the classpath of the application, so keep them in src/main/resources: in dev mode, src/test/resources is not part of the classpath.
See Dev Services for Amazon Services for the init script details.
The ARN of the queue created by Dev Services is fixed, so you can set it directly:
export RESOURCE_ARN=arn:aws:sqs:us-east-1:000000000000:quarkus-taggingCreate the queue with the AWS CLI of the Floci container:
queue_url=$(docker exec floci aws sqs create-queue --queue-name quarkus-tagging --query QueueUrl --output text)
export RESOURCE_ARN=$(docker exec floci aws sqs get-queue-attributes --queue-url $queue_url --attribute-names QueueArn --query Attributes.QueueArn --output text)Create the same queue with your own AWS CLI:
queue_url=$(aws sqs create-queue --queue-name quarkus-tagging --query QueueUrl --output text)
export RESOURCE_ARN=$(aws sqs get-queue-attributes --queue-url $queue_url --attribute-names QueueArn --query Attributes.QueueArn --output text)Any taggable resource works: you can use the ARN of an existing resource of your account instead.
Run the application in Dev Mode
Run the application in dev mode with:
./mvnw clean quarkus:devIf you use Dev Services, it starts a Floci container and configures the AWS Resource Groups Tagging API clients to use it. The Dev Services card of the Dev UI, at http://localhost:8080/q/dev-ui, shows the container and the endpoint it exposes.
-
Tag the resource created earlier with the synchronous client:
curl -XPOST "http://localhost:8080/sync/tag?arn=$RESOURCE_ARN&key=team&value=quarkus"It returns {}: no resource failed to be tagged.
-
Find the resources having the
teamtag with thequarkusvalue:
curl "http://localhost:8080/sync/resources?key=team&value=quarkus"It returns the ARN of the queue, for example ["arn:aws:sqs:us-east-1:000000000000:quarkus-tagging"].
-
List the tag keys and the values of the
teamtag:
curl http://localhost:8080/sync/tag-keys
curl "http://localhost:8080/sync/tag-values?key=team"They return ["team"] and ["quarkus"], along with the tags of the other resources of your account, if any.
-
Remove the
teamtag from the resource:
curl -XPOST "http://localhost:8080/sync/untag?arn=$RESOURCE_ARN&key=team"It returns {}, and the resources endpoint no longer returns the queue.
Next steps
Packaging
Packaging your application is as simple as ./mvnw clean package.
It can then be run with java -jar target/quarkus-app/quarkus-run.jar.
With GraalVM or Mandrel installed, you can also create a native executable binary:
./mvnw clean package -DnativeWithout GraalVM or Mandrel, build the native executable inside a container:
./mvnw clean package -Dnative -Dquarkus.native.container-build=trueDepending on your system, that will take some time.
Run the native executable with ./target/amazon-resourcegroupstaggingapi-quickstart-1.0.0-SNAPSHOT-runner.
Dev Services does not start in production mode, so you need to make sure that your application.properties file is configured to use your AWS account or a local stack.
To use a local Floci instance, pass the endpoint and the credentials on the command line:
|
java \
-Dquarkus.resourcegroupstaggingapi.endpoint-override=http://localhost:4566 \
-Dquarkus.resourcegroupstaggingapi.aws.region=us-east-1 \
-Dquarkus.resourcegroupstaggingapi.aws.credentials.type=static \
-Dquarkus.resourcegroupstaggingapi.aws.credentials.static-provider.access-key-id=test-key \
-Dquarkus.resourcegroupstaggingapi.aws.credentials.static-provider.secret-access-key=test-secret \
-jar target/quarkus-app/quarkus-run.jarSee the Packaging applications guide for more details.
Going asynchronous
Thanks to the AWS SDK v2.x used by the Quarkus extension, you can use the asynchronous programming model out of the box.
Create a org.acme.resourcegroupstaggingapi.QuarkusResourceGroupsTaggingApiAsyncResource REST resource that will be similar to our QuarkusResourceGroupsTaggingApiSyncResource but using an asynchronous programming model.
It reuses the tagFilter and errors helper methods of the synchronous resource.
package org.acme.resourcegroupstaggingapi;
import static org.acme.resourcegroupstaggingapi.QuarkusResourceGroupsTaggingApiSyncResource.errors;
import static org.acme.resourcegroupstaggingapi.QuarkusResourceGroupsTaggingApiSyncResource.tagFilter;
import java.util.List;
import java.util.Map;
import jakarta.inject.Inject;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import org.jboss.resteasy.reactive.RestQuery;
import io.smallrye.mutiny.Uni;
import software.amazon.awssdk.services.resourcegroupstaggingapi.ResourceGroupsTaggingApiAsyncClient;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagKeysResponse;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.GetTagValuesResponse;
import software.amazon.awssdk.services.resourcegroupstaggingapi.model.ResourceTagMapping;
@Path("/async")
@Produces(MediaType.APPLICATION_JSON)
public class QuarkusResourceGroupsTaggingApiAsyncResource {
@Inject
ResourceGroupsTaggingApiAsyncClient client;
@POST
@Path("/tag")
public Uni<Map<String, String>> tag(@RestQuery String arn, @RestQuery String key, @RestQuery String value) {
return Uni.createFrom()
.completionStage(client.tagResources(req -> req.resourceARNList(arn).tags(Map.of(key, value))))
.onItem().transform(response -> errors(response.failedResourcesMap()));
}
@POST
@Path("/untag")
public Uni<Map<String, String>> untag(@RestQuery String arn, @RestQuery String key) {
return Uni.createFrom()
.completionStage(client.untagResources(req -> req.resourceARNList(arn).tagKeys(key)))
.onItem().transform(response -> errors(response.failedResourcesMap()));
}
@GET
@Path("/resources")
public Uni<List<String>> resources(@RestQuery String key, @RestQuery String value) {
return Uni.createFrom().completionStage(client.getResources(req -> req.tagFilters(tagFilter(key, value))))
.onItem().transform(response -> response.resourceTagMappingList().stream()
.map(ResourceTagMapping::resourceARN)
.toList());
}
@GET
@Path("/tag-keys")
public Uni<List<String>> tagKeys() {
return Uni.createFrom().completionStage(client.getTagKeys())
.onItem().transform(GetTagKeysResponse::tagKeys);
}
@GET
@Path("/tag-values")
public Uni<List<String>> tagValues(@RestQuery String key) {
return Uni.createFrom().completionStage(client.getTagValues(req -> req.key(key)))
.onItem().transform(GetTagValuesResponse::tagValues);
}
}We create Uni instances from the CompletionStage objects returned by the asynchronous Resource Groups Tagging API client, and then transform the emitted item.
To enable the asynchronous client, you also need to add the Netty HTTP client dependency to the pom.xml:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>netty-nio-client</artifactId>
</dependency>If you want to use the AWS CRT-based HTTP client instead, configure it as follows:
quarkus.resourcegroupstaggingapi.async-client.type=aws-crtAnd add the following dependency to the application pom.xml:
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>aws-crt-client</artifactId>
</dependency>Quarkus dev mode picks up the new resource, and restarts by itself when pom.xml changes: if the application is still running, wait a few seconds, then call it again.
Otherwise, run it again with ./mvnw quarkus:dev.
-
Do the same with the asynchronous client, using the
/asyncpath instead of/sync.
Going further
You have built a Quarkus application that uses AWS Resource Groups Tagging API, developed locally against Dev Services and ready to run on your AWS account. You are all set to build great applications with AWS Resource Groups Tagging API, with the fast startup, the low memory footprint and the developer joy of Quarkus.
To go further:
-
Common features: named clients, overriding the client configuration, custom AWS credentials providers.
-
Dev Services for Amazon Services: stack providers, shared containers, init scripts.
-
OpenTelemetry for Amazon Services: trace the calls of the AWS SDK.
Configuration Reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Configuration property |
Type |
Default |
|---|---|---|
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 Environment variable: |
list of string |
|
OpenTelemetry AWS SDK instrumentation will be enabled if the OpenTelemetry extension is present and this value is true. Environment variable: |
boolean |
|
Type of the sync HTTP client implementation Environment variable: |
|
|
Type of the async HTTP client implementation Environment variable: |
|
|
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. The local AWS stack is provided by the stack provider configured with Environment variable: |
boolean |
|
Generic properties that are pass for additional container configuration. Environment variable: |
Map<String,String> |
|
The dev services stack provider to use for this service. If not specified, the global setting from quarkus.aws.devservices.provider is used. Supported values: "floci", "localstack", "ministack", "moto" This allows per-service override of the global stack selection. Environment variable: |
|
|
Type |
Default |
|
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: |
||
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: |
||
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: |
||
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: |
boolean |
|
Type |
Default |
|
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 Environment variable: |
Region |
|
Configure the credentials provider that should be used to authenticate with AWS. Available values:
Environment variable: |
|
|
Type |
Default |
|
Whether this provider should fetch credentials asynchronously in the background. If this is Environment variable: |
boolean |
|
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: |
boolean |
|
Type |
Default |
|
AWS Access key id Environment variable: |
string |
|
AWS Secret access key Environment variable: |
string |
|
AWS Session token Environment variable: |
string |
|
Type |
Default |
|
The name of the profile that should be used by this credentials provider. If not specified, the value in Environment variable: |
string |
|
Type |
Default |
|
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: |
boolean |
|
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: |
|
|
The maximum size of the output that can be returned by the external process before an exception is raised. Environment variable: |
|
|
The command that should be executed to retrieve credentials. Command and parameters are seperated list entries. Environment variable: |
list of string |
|
Type |
Default |
|
The name of custom AwsCredentialsProvider bean. Environment variable: |
string |
|
Type |
Default |
|
The maximum amount of time to establish a connection before timing out. Environment variable: |
|
|
The amount of time to wait for data to be transferred over an established, open connection before the connection is timed out. Environment variable: |
|
|
TLS key managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
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: |
string |
|
Key store password Environment variable: |
string |
|
TLS trust managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
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: |
string |
|
Key store password Environment variable: |
string |
|
Type |
Default |
|
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open while idle. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. Environment variable: |
||
The maximum number of connections allowed in the connection pool. Each built HTTP client has its own private connection pool. Environment variable: |
int |
|
Whether the client should send an HTTP expect-continue handshake before each request. Environment variable: |
boolean |
|
Whether the idle connections in the connection pool should be closed asynchronously. When enabled, connections left idling for longer than Environment variable: |
boolean |
|
Configure whether to enable or disable TCP KeepAlive. Environment variable: |
boolean |
|
Enable HTTP proxy Environment variable: |
boolean |
|
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: |
||
The username to use when connecting through a proxy. Environment variable: |
string |
|
The password to use when connecting through a proxy. Environment variable: |
string |
|
For NTLM proxies - the Windows domain name to use when authenticating with the proxy. Environment variable: |
string |
|
For NTLM proxies - the Windows workstation name to use when authenticating with the proxy. Environment variable: |
string |
|
Whether to attempt to authenticate preemptively against the proxy server using basic authentication. Environment variable: |
boolean |
|
The hosts that the client is allowed to access without going through the proxy. Environment variable: |
list of string |
|
Type |
Default |
|
The maximum amount of time that a connection should be allowed to remain open while idle. Environment variable: |
|
|
The maximum number of allowed concurrent requests. Environment variable: |
int |
|
The amount of time to wait when initially establishing a connection before giving up and timing out. Environment variable: |
|
|
Enable HTTP proxy Environment variable: |
boolean |
|
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: |
||
The username to use when connecting through a proxy. Environment variable: |
string |
|
The password to use when connecting through a proxy. Environment variable: |
string |
|
Configure whether to enable or disable TCP KeepAlive. Environment variable: |
boolean |
|
Time between TCP keepalive packets being sent to the peer. Environment variable: |
|
|
Time to wait for a keepalive response before considering the connection timed out. Environment variable: |
|
|
Number of keepalive probes allowed to fail before the connection is considered lost. Environment variable: |
int |
|
Type |
Default |
|
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: |
int |
|
The maximum number of pending acquires allowed. Once this exceeds, acquire tries will be failed. Environment variable: |
int |
|
The amount of time to wait for a read on a socket before an exception is thrown. Specify Environment variable: |
|
|
The amount of time to wait for a write on a socket before an exception is thrown. Specify Environment variable: |
|
|
The amount of time to wait when initially establishing a connection before giving up and timing out. Environment variable: |
|
|
The amount of time to wait when acquiring a connection from the pool before giving up and timing out. Environment variable: |
|
|
The maximum amount of time that a connection should be allowed to remain open, regardless of usage frequency. Environment variable: |
||
The maximum amount of time that a connection should be allowed to remain open while idle. Currently has no effect if Environment variable: |
|
|
Whether the idle connections in the connection pool should be closed. When enabled, connections left idling for longer than Environment variable: |
boolean |
|
Configure whether to enable or disable TCP KeepAlive. Applicable only to netty-nio client. Environment variable: |
boolean |
|
Type |
Default |
|
The maximum amount of time that a connection should be allowed to remain open while idle. Environment variable: |
|
|
The maximum number of allowed concurrent requests. Environment variable: |
int |
|
The amount of time to wait when initially establishing a connection before giving up and timing out. Environment variable: |
|
|
Enable HTTP proxy Environment variable: |
boolean |
|
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: |
||
The username to use when connecting through a proxy. Environment variable: |
string |
|
The password to use when connecting through a proxy. Environment variable: |
string |
|
Configure whether to enable or disable TCP KeepAlive. Environment variable: |
boolean |
|
Time between TCP keepalive packets being sent to the peer. Environment variable: |
|
|
Time to wait for a keepalive response before considering the connection timed out. Environment variable: |
|
|
Number of keepalive probes allowed to fail before the connection is considered lost. Environment variable: |
int |
|
The HTTP protocol to use. Environment variable: |
|
|
The SSL Provider to be used in the Netty client. Default is Environment variable: |
|
|
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: |
long |
|
The initial window size for an HTTP/2 stream. This setting is only respected when the HTTP/2 protocol is used. Environment variable: |
int |
|
Sets the period that the Netty client will send This setting is only respected when the HTTP/2 protocol is used. Environment variable: |
|
|
Enable HTTP proxy. Environment variable: |
boolean |
|
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: |
||
The hosts that the client is allowed to access without going through the proxy. Environment variable: |
list of string |
|
TLS key managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
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: |
string |
|
Key store password Environment variable: |
string |
|
TLS trust managers provider type. Available providers:
Environment variable: |
|
|
Path to the key store. Environment variable: |
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: |
string |
|
Key store password Environment variable: |
string |
|
Enable the custom configuration of the Netty event loop group. This option is only available when using Quarkus 3.x. With Quarkus 4, the AWS SDK always uses its own event loop. Environment variable: |
boolean |
|
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 Environment variable: |
int |
|
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 Environment variable: |
string |
|
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: |
boolean |
|
|
About the Duration format
To write duration values, use the standard You can also use a simplified format, starting with a number:
In other cases, the simplified format is translated to the
|
|
About the MemorySize format
A size configuration option recognizes strings in this format (shown as a regular expression): If no suffix is given, assume bytes. |