Amazon SES Client
Amazon Simple Email Service (Amazon SES) is a cloud email service for sending and receiving email. This client uses the original SES API (v1), which you still need to manage email receiving, with receipt rules and filters. For sending, AWS recommends the SES API v2, available in the Amazon SES API v2 extension, as new sending features are only added there.
For more information, see the Amazon SES documentation.
| The Amazon SES 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 Amazon SES 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 Amazon SES 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 Amazon SES 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-compat
This 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.
Solution
The application built here allows sending text emails to the recipients that are verified on AWS SES.
It uses the synchronous client first, then the asynchronous client in Going asynchronous.
We recommend that you follow the instructions in the next sections and create the application step by step. However, you can go right to the completed example.
Clone the Git repository: git clone https://github.com/quarkusio/quarkus-quickstarts.git, or download an archive.
The solution is located in the amazon-ses-quickstart directory.
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-ses-quickstart \
-DclassName="org.acme.ses.QuarkusSesSyncResource" \
-Dpath="/sync" \
-Dextensions="rest-jackson,amazon-ses"
cd amazon-ses-quickstart
This command generates a Maven structure importing the Quarkus REST and Amazon SES Client extensions.
After this, the amazon-ses extension has been added to your pom.xml, along with quarkus-rest and quarkus-rest-jackson.
The Amazon SES 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 QuarkusSesSyncResourceTest class and a QuarkusSesSyncResourceIT 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
First, let’s create the Email bean that represents the email to send:
package org.acme.ses.model;
import io.quarkus.runtime.annotations.RegisterForReflection;
@RegisterForReflection
public class Email {
private String from;
private String to;
private String subject;
private String body;
public String getFrom() {
return from;
}
public String getTo() {
return to;
}
public String getSubject() {
return subject;
}
public String getBody() {
return body;
}
public Email setFrom(String from) {
this.from = from;
return this;
}
public Email setTo(String to) {
this.to = to;
return this;
}
public Email setSubject(String subject) {
this.subject = subject;
return this;
}
public Email setBody(String body) {
this.body = body;
return this;
}
}
The @RegisterForReflection annotation instructs Quarkus to keep the class and its members during the native compilation. More details about the @RegisterForReflection annotation can be found on the native application tips page.
|
Then, create a org.acme.ses.QuarkusSesSyncResource that will provide an API to send emails using the synchronous client.
package org.acme.ses;
import jakarta.inject.Inject;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import org.acme.ses.model.Email;
import software.amazon.awssdk.services.ses.SesClient;
@Path("/sync")
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.APPLICATION_JSON)
public class QuarkusSesSyncResource {
@Inject
SesClient ses;
@POST
@Path("/email")
public String send(Email data) {
return ses.sendEmail(req -> req
.source(data.getFrom())
.destination(d -> d.toAddresses(data.getTo()))
.message(msg -> msg
.subject(sub -> sub.data(data.getSubject()))
.body(b -> b.text(txt -> txt.data(data.getBody()))))).messageId();
}
}
Configuring Amazon SES clients
Both Amazon SES 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.ses.sync-client.type=apache5
And 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.ses.sync-client.type=apache
And 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.ses.sync-client.type=aws-crt
And 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.ses.endpoint-override=http://localhost:4566 (1)
quarkus.ses.aws.region=us-east-1 (2)
quarkus.ses.aws.credentials.type=static (3)
quarkus.ses.aws.credentials.static-provider.access-key-id=test-key
quarkus.ses.aws.credentials.static-provider.secret-access-key=test-secret
| 1 | Override the Amazon SES client to use Floci instead of the actual AWS service. When it is set, Dev Services does not start a local stack for Amazon SES. |
| 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 Amazon SES 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 Amazon SES 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. |
Verify the sender address
Floci rejects a send request when the sender address is not verified, but it does not require the recipient to be verified, and it does not send any email.
You do not need the AWS CLI: list the sender addresses in application.properties:
quarkus.ses.devservices.verified-emails=from-quarkus@example.com
Dev Services verifies these addresses when it starts the Floci container, and also when it reuses a Floci container already started by another Quarkus application in dev mode.
Verify the sender address with the AWS CLI of the Floci container:
docker exec floci aws ses verify-email-identity --email-address from-quarkus@example.com
Amazon applies certain restrictions to new Amazon SES accounts, mainly to prevent fraud and abuse. All new accounts are in the Amazon SES sandbox. All the features of the Amazon SES are still available while in sandbox, but the following restrictions apply:
-
You can send mail to verified email addresses and domains or to the Amazon SES mailbox simulator
-
You can only send mail from verified email addresses and domains
-
You can send a maximum of 1 message per second.
Going production, you’d need to get your account out of the sandbox following the Amazon procedure.
We assume you are going to use the AWS SES sandbox for the sake of this guide. Before sending any email, you must verify the sender address, and, while in the sandbox, the recipient address, using the AWS CLI. You can use your personal email or any temporary email service available if you wish.
aws ses verify-email-identity --email-address <sender@email.address>
aws ses verify-email-identity --email-address <recipient@email.address>
Then open the mailboxes of those email addresses to follow the confirmation procedure. Once an email is approved, you can use it in your application.
Run the application in Dev Mode
Run the application in dev mode with:
./mvnw clean quarkus:dev
If you use Dev Services, it starts a Floci container and configures the Amazon SES 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.
-
Send an email with the synchronous client:
curl -XPOST -H"Content-type: application/json" http://localhost:8080/sync/email \
-d'{"from": "from-quarkus@example.com", "to": "to-quarkus@example.com", "subject": "Hello from Quarkus", "body": "Quarkus is awesome"}'
The response is the message id returned by SES. Remember that the sender address must be verified, even on Floci, and that a local instance does not actually send any email.
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 -Dnative
Without GraalVM or Mandrel, build the native executable inside a container:
./mvnw clean package -Dnative -Dquarkus.native.container-build=true
Depending on your system, that will take some time.
Run the native executable with ./target/amazon-ses-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.ses.endpoint-override=http://localhost:4566 \
-Dquarkus.ses.aws.region=us-east-1 \
-Dquarkus.ses.aws.credentials.type=static \
-Dquarkus.ses.aws.credentials.static-provider.access-key-id=test-key \
-Dquarkus.ses.aws.credentials.static-provider.secret-access-key=test-secret \
-jar target/quarkus-app/quarkus-run.jar
See 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.ses.QuarkusSesAsyncResource REST resource that will be similar to our QuarkusSesSyncResource but using an asynchronous programming model.
package org.acme.ses;
import io.smallrye.mutiny.Uni;
import jakarta.inject.Inject;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;
import org.acme.ses.model.Email;
import software.amazon.awssdk.services.ses.SesAsyncClient;
import software.amazon.awssdk.services.ses.model.SendEmailResponse;
@Path("/async")
@Produces(MediaType.TEXT_PLAIN)
@Consumes(MediaType.APPLICATION_JSON)
public class QuarkusSesAsyncResource {
@Inject
SesAsyncClient ses;
@POST
@Path("/email")
public Uni<String> send(Email data) {
return Uni.createFrom()
.completionStage(
ses.sendEmail(req -> req
.source(data.getFrom())
.destination(d -> d.toAddresses(data.getTo()))
.message(msg -> msg
.subject(sub -> sub.data(data.getSubject()))
.body(b -> b.text(txt -> txt.data(data.getBody()))))))
.onItem().transform(SendEmailResponse::messageId);
}
}
We create Uni instances from the CompletionStage objects returned by the asynchronous SES 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.ses.async-client.type=aws-crt
And 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.
-
Send an email with the asynchronous client:
curl -XPOST -H"Content-type: application/json" http://localhost:8080/async/email \
-d'{"from": "from-quarkus@example.com", "to": "to-quarkus@example.com", "subject": "Hello from Quarkus", "body": "Quarkus is awesome"}'
Going further
You have built a Quarkus application that uses Amazon SES, developed locally against Dev Services and ready to run on your AWS account. You are all set to build great applications with Amazon SES, 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.
-
The completed example, in the
amazon-ses-quickstartdirectory of the Quarkus quickstarts.
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: |
|
|
The email addresses to verify on startup, so that they can be used as sender addresses. Environment variable: |
list of string |
|
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. |