Amazon SNS Client

Amazon Simple Notification Service (SNS) is a highly available and fully managed pub/sub messaging service. It provides topics for high-throughput, push-based, many-to-many messaging. Messages can fan out to a large number of subscriber endpoints for parallel processing, including Amazon SQS queues, AWS Lambda functions, and HTTP/S webhooks. Additionally, SNS can be used to fan out notifications to end users using mobile push, SMS and email.

For more information, see the Amazon SNS documentation.

The 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 CompletableFuture objects 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 SNS locally and on AWS.

Prerequisites

To complete this guide, you need:

  • JDK 21+ installed with JAVA_HOME configured appropriately

  • an IDE

  • Apache Maven 3.8.1+

  • Docker, to run Amazon SNS 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 SNS 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.

Amazon SNS calls your application from the container, through host.docker.internal. Docker Desktop provides this name, and on Linux Dev Services maps it to your host. The container reaches your host through a network interface, not localhost, so the application must listen on all interfaces:

quarkus.http.host=0.0.0.0

Be aware that with quarkus.http.host=0.0.0.0, Quarkus listens to all interfaces, which might be a security hazard depending on your network configuration.

Start Floci manually

You can also start a Floci container yourself:

docker run --rm --name floci --publish 4566:4566 --add-host=host.docker.internal:host-gateway -d floci/floci:latest-compat

Amazon SNS calls your application from the container: the --add-host option lets the container reach your host as host.docker.internal. Docker Desktop already provides this name, but on Linux the option is required (extra_hosts with Docker Compose).

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 to shoot elementary particles (quarks) into a QuarksCollider topic of the AWS SNS. Additionally, we create a resource that allows to subscribe to the QuarksCollider topic in order to receive published quarks.

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-sns-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.Beta2:create \
    -DprojectGroupId=org.acme \
    -DprojectArtifactId=amazon-sns-quickstart \
    -DclassName="org.acme.sns.QuarksCannonSyncResource" \
    -Dpath="/sync/cannon" \
    -Dextensions="rest-jackson,amazon-sns"
cd amazon-sns-quickstart

This command generates a Maven structure importing the Quarkus REST and Amazon SNS Client extensions. After this, the amazon-sns extension has been added to your pom.xml, along with quarkus-rest and quarkus-rest-jackson.

The Amazon SNS 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.Beta4</version>
    <type>pom</type>
    <scope>import</scope>
</dependency>

The command also generates a QuarksCannonSyncResourceTest class and a QuarksCannonSyncResourceIT 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 Quark bean as follows:

package org.acme.sns.model;

import io.quarkus.runtime.annotations.RegisterForReflection;
import java.util.Objects;

@RegisterForReflection
public class Quark {

    private String flavor;
    private String spin;

    public Quark() {
    }

    public String getFlavor() {
        return flavor;
    }

    public void setFlavor(String flavor) {
        this.flavor = flavor;
    }

    public String getSpin() {
        return spin;
    }

    public void setSpin(String spin) {
        this.spin = spin;
    }

    @Override
    public boolean equals(Object obj) {
        if (!(obj instanceof Quark)) {
            return false;
        }

        Quark other = (Quark) obj;

        return Objects.equals(other.flavor, this.flavor);
    }

    @Override
    public int hashCode() {
        return Objects.hash(this.flavor);
    }
}

Then, create a org.acme.sns.QuarksCannonSyncResource that will provide an API to shoot quarks into the SNS topic via the SNS synchronous client.

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. 
package org.acme.sns;

import tools.jackson.databind.ObjectWriter;
import tools.jackson.databind.json.JsonMapper;
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 jakarta.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.PublishResponse;

@Path("/sync/cannon")
@Produces(MediaType.TEXT_PLAIN)
public class QuarksCannonSyncResource {

    private static final Logger LOGGER = Logger.getLogger(QuarksCannonSyncResource.class);

    @Inject
    SnsClient sns;

    @ConfigProperty(name = "topic.arn")
    String topicArn;

    static ObjectWriter QUARK_WRITER = JsonMapper.builder().build().writerFor(Quark.class);

    @POST
    @Path("/shoot")
    @Consumes(MediaType.APPLICATION_JSON)
    public Response publish(Quark quark) throws Exception {
        String message = QUARK_WRITER.writeValueAsString(quark);
        PublishResponse response = sns.publish(p -> p.topicArn(topicArn).message(message));
        LOGGER.infov("Fired Quark[{0}, {1}]", quark.getFlavor(), quark.getSpin());
        return Response.ok().entity(response.messageId()).build();
    }
}

Because of the fact that messages published must be simply a String we’re using Jackson’s ObjectWriter in order to serialize our Quark objects into a String.

The missing piece is the subscriber that will receive the messages published to our topic. Before implementing subscribers, we need to define POJO classes representing messages posted by the AWS SNS.

Let’s create two classes that represent SNS Notification and SNS Subscription Confirmation messages based on the AWS SNS Message and JSON formats

Create org.acme.sns.model.SnsNotification class

package org.acme.sns.model;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Based on https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html#http-notification-json
 */
@JsonIgnoreProperties(ignoreUnknown = true)
public class SnsNotification {

    @JsonProperty("Message")
    private String message;

    @JsonProperty("MessageId")
    private String messageId;

    @JsonProperty("Signature")
    private String signature;

    @JsonProperty("SignatureVersion")
    private String signatureVersion;

    @JsonProperty("SigningCertURL")
    private String signinCertUrl;

    @JsonProperty("Subject")
    private String subject;

    @JsonProperty("Timestamp")
    private String timestamp;

    @JsonProperty("TopicArn")
    private String topicArn;

    @JsonProperty("Type")
    private String type;

    @JsonProperty("UnsubscribeURL")
    private String unsubscribeURL;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getMessageId() {
        return messageId;
    }

    public void setMessageId(String messageId) {
        this.messageId = messageId;
    }

    public String getSignature() {
        return signature;
    }

    public void setSignature(String signature) {
        this.signature = signature;
    }

    public String getSignatureVersion() {
        return signatureVersion;
    }

    public void setSignatureVersion(String signatureVersion) {
        this.signatureVersion = signatureVersion;
    }

    public String getSigninCertUrl() {
        return signinCertUrl;
    }

    public void setSigninCertUrl(String signinCertUrl) {
        this.signinCertUrl = signinCertUrl;
    }

    public String getSubject() {
        return subject;
    }

    public void setSubject(String subject) {
        this.subject = subject;
    }

    public String getTimestamp() {
        return timestamp;
    }

    public void setTimestamp(String timestamp) {
        this.timestamp = timestamp;
    }

    public String getTopicArn() {
        return topicArn;
    }

    public void setTopicArn(String topicArn) {
        this.topicArn = topicArn;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getUnsubscribeURL() {
        return unsubscribeURL;
    }

    public void setUnsubscribeURL(String unsubscribeURL) {
        this.unsubscribeURL = unsubscribeURL;
    }
}

Then, create org.acme.sns.model.SnsSubscriptionConfirmation

package org.acme.sns.model;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * Based on https://docs.aws.amazon.com/sns/latest/dg/sns-message-and-json-formats.html#http-subscription-confirmation-json
 */
public class SnsSubscriptionConfirmation {

    @JsonProperty("Message")
    private String message;

    @JsonProperty("MessageId")
    private String messageId;

    @JsonProperty("Signature")
    private String signature;

    @JsonProperty("SignatureVersion")
    private String signatureVersion;

    @JsonProperty("SigningCertURL")
    private String signingCertUrl;

    @JsonProperty("SubscribeURL")
    private String subscribeUrl;

    @JsonProperty("Timestamp")
    private String timestamp;

    @JsonProperty("Token")
    private String token;

    @JsonProperty("TopicArn")
    private String topicArn;

    @JsonProperty("Type")
    private String type;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public String getMessageId() {
        return messageId;
    }

    public void setMessageId(String messageId) {
        this.messageId = messageId;
    }

    public String getSignature() {
        return signature;
    }

    public void setSignature(String signature) {
        this.signature = signature;
    }

    public String getSignatureVersion() {
        return signatureVersion;
    }

    public void setSignatureVersion(String signatureVersion) {
        this.signatureVersion = signatureVersion;
    }

    public String getSigningCertUrl() {
        return signingCertUrl;
    }

    public void setSigningCertUrl(String signingCertUrl) {
        this.signingCertUrl = signingCertUrl;
    }

    public String getSubscribeUrl() {
        return subscribeUrl;
    }

    public void setSubscribeUrl(String subscribeUrl) {
        this.subscribeUrl = subscribeUrl;
    }

    public String getTimestamp() {
        return timestamp;
    }

    public void setTimestamp(String timestamp) {
        this.timestamp = timestamp;
    }

    public String getToken() {
        return token;
    }

    public void setToken(String token) {
        this.token = token;
    }

    public String getTopicArn() {
        return topicArn;
    }

    public void setTopicArn(String topicArn) {
        this.topicArn = topicArn;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }
}

Now, create org.acme.sns.QuarksShieldSyncResource REST resources that: - Allows to subscribe itself to our SNS topic - Unsubscribe from the SNS topic - Receive notifications from the subscribed SNS topic

Keep in mind that AWS SNS supports multiple types of subscribers (that is web servers, email addresses, AWS SQS queues, AWS Lambda functions, and many more), but for the sake of the quickstart we will show how to subscribe an HTTP endpoint served by our application. 
package org.acme.sns;

import tools.jackson.core.JacksonException;
import tools.jackson.databind.ObjectReader;
import tools.jackson.databind.json.JsonMapper;
import java.util.HashMap;
import java.util.Map;
import jakarta.inject.Inject;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.HeaderParam;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.acme.sns.model.SnsNotification;
import org.acme.sns.model.SnsSubscriptionConfirmation;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsClient;
import software.amazon.awssdk.services.sns.model.SubscribeResponse;

@Path("/sync/shield")
public class QuarksShieldSyncResource {

    private static final Logger LOGGER = Logger.getLogger(QuarksShieldSyncResource.class);

    private static final String NOTIFICATION_TYPE = "Notification";
    private static final String SUBSCRIPTION_CONFIRMATION_TYPE = "SubscriptionConfirmation";
    private static final String UNSUBSCRIPTION_CONFIRMATION_TYPE = "UnsubscribeConfirmation";

    @Inject
    SnsClient sns;

    @ConfigProperty(name = "topic.arn")
    String topicArn;

    @ConfigProperty(name = "quarks.shield.base.url")
    String quarksShieldBaseUrl;

    private volatile String subscriptionArn;

    static Map<Class<?>, ObjectReader> READERS = new HashMap<>();

    static {
        READERS.put(SnsNotification.class, JsonMapper.builder().build().readerFor(SnsNotification.class));
        READERS.put(SnsSubscriptionConfirmation.class, JsonMapper.builder().build().readerFor(SnsSubscriptionConfirmation.class));
        READERS.put(Quark.class, JsonMapper.builder().build().readerFor(Quark.class));
    }

    @POST
    @Consumes({MediaType.TEXT_PLAIN})
    public Response notificationEndpoint(@HeaderParam("x-amz-sns-message-type") String messageType, String message) throws JacksonException {
        if (messageType == null) {
            return Response.status(400).build();
        }

        if (messageType.equals(NOTIFICATION_TYPE)) {
            SnsNotification notification = readObject(SnsNotification.class, message);
            Quark quark = readObject(Quark.class, notification.getMessage());
            LOGGER.infov("Quark[{0}, {1}] collision with the shield.", quark.getFlavor(), quark.getSpin());
        } else if (messageType.equals(SUBSCRIPTION_CONFIRMATION_TYPE)) {
            SnsSubscriptionConfirmation subConf = readObject(SnsSubscriptionConfirmation.class, message);
            sns.confirmSubscription(cs -> cs.topicArn(topicArn).token(subConf.getToken()));
            LOGGER.info("Subscription confirmed. Ready for quarks collisions.");
        } else if (messageType.equals(UNSUBSCRIPTION_CONFIRMATION_TYPE)) {
            LOGGER.info("We are unsubscribed");
        } else {
            return Response.status(400).entity("Unknown messageType").build();
        }

        return Response.ok().build();
    }

    @POST
    @Path("/subscribe")
    public Response subscribe() {
        String notificationEndpoint = notificationEndpoint();
        SubscribeResponse response = sns.subscribe(s -> s.topicArn(topicArn).protocol("http").endpoint(notificationEndpoint));
        subscriptionArn = response.subscriptionArn();
        LOGGER.infov("Subscribed Quarks shield <{0}> : {1} ", notificationEndpoint, response.subscriptionArn());
        return Response.ok().entity(response.subscriptionArn()).build();
    }

    @POST
    @Path("/unsubscribe")
    public Response unsubscribe() {
        if (subscriptionArn != null) {
            sns.unsubscribe(s -> s.subscriptionArn(subscriptionArn));
            LOGGER.infov("Unsubscribed quarks shield for id = {0}", subscriptionArn);
            return Response.ok().build();
        } else {
            LOGGER.info("Not subscribed yet");
            return Response.status(400).entity("Not subscribed yet").build();
        }
    }

    private String notificationEndpoint() {
        return quarksShieldBaseUrl + "/sync/shield";
    }

    private <T> T readObject(Class<T> clazz, String message) {
        T object = null;
        try {
            object = READERS.get(clazz).readValue(message);
        } catch (JacksonException e) {
            LOGGER.errorv("Unable to deserialize message <{0}> to Class <{1}>", message, clazz.getSimpleName());
            throw new RuntimeException(e);
        }
        return object;
    }
}

  1. subscribe() endpoint subscribes to our topic by providing the URL to the POST endpoint receiving SNS notification requests.

  2. unsubscribe() simply removes our subscription, so any messages published to the topic will not be routed to our endpoint anymore

  3. notificationEndpoint() is called by SNS on new message if endpoint is subscribed. See Amazon SNS message and JSON formats for details about the format of the messages SNS can submit.

Configuring Amazon SNS clients

Both Amazon SNS 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.sns.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.sns.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 apache5. The build logs a warning when the Apache HTTP client is used. Set quarkus.aws.sync-client.apache-deprecation-warning=false to disable it, see Deprecated Apache HTTP client.

If you want to use the AWS CRT-based HTTP client instead, configure it as follows:

quarkus.sns.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.sns.endpoint-override=http://localhost:4566 (1)

quarkus.sns.aws.region=us-east-1 (2)
quarkus.sns.aws.credentials.type=static (3)
quarkus.sns.aws.credentials.static-provider.access-key-id=test-key
quarkus.sns.aws.credentials.static-provider.secret-access-key=test-secret
1 Override the Amazon SNS client to use Floci instead of the actual AWS service. When it is set, Dev Services does not start a local stack for Amazon SNS.
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 SNS 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 SNS client uses the default credentials provider chain that looks for credentials in this order:

  • 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 ECS if the AWS_CONTAINER_CREDENTIALS_RELATIVE_URI environment 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 endpoint-override, Dev Services starts a local stack for Amazon SNS in dev and test modes, and the client uses it instead of your AWS account. Removing the endpoint-override is therefore not enough to use your AWS account in these modes: also disable Dev Services for Amazon SNS:

quarkus.sns.devservices.enabled=false

Dev Services never starts in production mode.

Create the SNS topic

Set the name of the topic used by the application, and the ARN the clients publish to:

topic.name=QuarksCollider
topic.arn=arn:aws:sns:us-east-1:000000000000:${topic.name}

SNS sends the notifications to the HTTP endpoint served by the application, so the topic must be able to reach it:

quarks.shield.base.url=http://host.docker.internal:${quarkus.http.port}
quarkus.http.host=0.0.0.0
With Dev Services

Let Dev Services create the topic on startup:

quarkus.sns.devservices.topics=${topic.name}
On a manually started Floci

Create the topic using the AWS CLI of the Floci container and store its ARN in the TOPIC_ARN environment variable:

export TOPIC_ARN=$(docker exec floci aws sns create-topic --name=QuarksCollider --query TopicArn --output text)
On your AWS account

Create the topic using your default profile:

export TOPIC_ARN=$(aws sns create-topic --name=QuarksCollider --query TopicArn --output text)

On AWS, SNS delivers the notifications over the internet, so it cannot reach host.docker.internal or localhost. Set quarks.shield.base.url to a public URL of your application, for example a tunnel to your machine or a deployed instance. Publishing works without it, but the shield does not receive the notifications.

Quarkus reads the TOPIC_ARN environment variable as the topic.arn property, so run the application from the same terminal, or pass the ARN explicitly with -Dtopic.arn=$TOPIC_ARN.

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 SNS 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.

  • Subscribe the application to the topic with the synchronous client:

curl -XPOST -H'Content-type: application/json' http://localhost:8080/sync/shield/subscribe

  • Shoot a quark and observe the collision in the application logs:

curl -XPOST -H'Content-type: application/json' http://localhost:8080/sync/cannon/shoot -d'{"flavor": "Charm", "spin": "1/2"}'

  • Unsubscribe with /sync/shield/unsubscribe to stop receiving notifications.

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-sns-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.sns.endpoint-override=http://localhost:4566 \
    -Dquarkus.sns.aws.region=us-east-1 \
    -Dquarkus.sns.aws.credentials.type=static \
    -Dquarkus.sns.aws.credentials.static-provider.access-key-id=test-key \
    -Dquarkus.sns.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.sns.QuarksCannonAsyncResource REST resource that will be similar to our QuarksCannonSyncResource but using an asynchronous programming model.

package org.acme.sns;

import tools.jackson.databind.ObjectWriter;
import tools.jackson.databind.json.JsonMapper;
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 jakarta.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsAsyncClient;
import software.amazon.awssdk.services.sns.model.PublishResponse;

@Path("/async/cannon")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
public class QuarksCannonAsyncResource {

    private static final Logger LOGGER = Logger.getLogger(QuarksCannonAsyncResource.class);

    @Inject
    SnsAsyncClient sns;

    @ConfigProperty(name = "topic.arn")
    String topicArn;

    static ObjectWriter QUARK_WRITER = JsonMapper.builder().build().writerFor(Quark.class);

    @POST
    @Path("/shoot")
    @Consumes(MediaType.APPLICATION_JSON)
    public Uni<Response> publish(Quark quark) throws Exception {
        String message = QUARK_WRITER.writeValueAsString(quark);
        return Uni.createFrom()
            .completionStage(sns.publish(p -> p.topicArn(topicArn).message(message)))
            .onItem().invoke(item -> LOGGER.infov("Fired Quark[{0}, {1}]", quark.getFlavor(), quark.getSpin()))
            .onItem().transform(PublishResponse::messageId)
            .onItem().transform(id -> Response.ok().entity(id).build());
    }
}

We create Uni instances from the CompletionStage objects returned by the asynchronous SNS client, and then transform the emitted item.

And corresponding async subscriber org.acme.sns.QuarksShieldAsyncResource

package org.acme.sns;

import tools.jackson.core.JacksonException;
import tools.jackson.databind.ObjectReader;
import tools.jackson.databind.json.JsonMapper;
import io.smallrye.mutiny.Uni;
import java.util.HashMap;
import java.util.Map;
import jakarta.inject.Inject;
import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.HeaderParam;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import org.acme.sns.model.Quark;
import org.acme.sns.model.SnsNotification;
import org.acme.sns.model.SnsSubscriptionConfirmation;
import org.eclipse.microprofile.config.inject.ConfigProperty;
import org.jboss.logging.Logger;
import software.amazon.awssdk.services.sns.SnsAsyncClient;
import software.amazon.awssdk.services.sns.model.SubscribeResponse;

@Path("/async/shield")
public class QuarksShieldAsyncResource {

    private static final Logger LOGGER = Logger.getLogger(QuarksShieldAsyncResource.class);

    private static final String NOTIFICATION_TYPE = "Notification";
    private static final String SUBSCRIPTION_CONFIRMATION_TYPE = "SubscriptionConfirmation";
    private static final String UNSUBSCRIPTION_CONFIRMATION_TYPE = "UnsubscribeConfirmation";

    @Inject
    SnsAsyncClient sns;

    @ConfigProperty(name = "topic.arn")
    String topicArn;

    @ConfigProperty(name = "quarks.shield.base.url")
    String quarksShieldBaseUrl;

    private volatile String subscriptionArn;

    static Map<Class<?>, ObjectReader> READERS = new HashMap<>();

    static {
        READERS.put(SnsNotification.class, JsonMapper.builder().build().readerFor(SnsNotification.class));
        READERS.put(SnsSubscriptionConfirmation.class, JsonMapper.builder().build().readerFor(SnsSubscriptionConfirmation.class));
        READERS.put(Quark.class, JsonMapper.builder().build().readerFor(Quark.class));
    }

    @POST
    @Consumes({MediaType.TEXT_PLAIN})
    public Uni<Response> notificationEndpoint(@HeaderParam("x-amz-sns-message-type") String messageType, String message) {
        if (messageType == null) {
            return Uni.createFrom().item(Response.status(400).build());
        }

        if (messageType.equals(NOTIFICATION_TYPE)) {
            return Uni.createFrom().item(readObject(SnsNotification.class, message))
                .onItem().transform(notification -> readObject(Quark.class, notification.getMessage()))
                .onItem().invoke(quark -> LOGGER.infov("Quark[{0}, {1}] collision with the shield.", quark.getFlavor(), quark.getSpin()))
                .onItem().transform(quark -> Response.ok().build());
        } else if (messageType.equals(SUBSCRIPTION_CONFIRMATION_TYPE)) {
            return Uni.createFrom().item(readObject(SnsSubscriptionConfirmation.class, message))
                .onItem().transformToUni(msg ->
                            Uni.createFrom().completionStage(
                                    sns.confirmSubscription(confirm -> confirm.topicArn(topicArn).token(msg.getToken()))
                            )
                    )
                .onItem().invoke(resp -> LOGGER.info("Subscription confirmed. Ready for quarks collisions."))
                .onItem().transform(resp -> Response.ok().build());
        } else if (messageType.equals(UNSUBSCRIPTION_CONFIRMATION_TYPE)) {
            LOGGER.info("We are unsubscribed");
            return Uni.createFrom().item(Response.ok().build());
        }

        return Uni.createFrom().item(Response.status(400).entity("Unknown messageType").build());
    }

    @POST
    @Path("/subscribe")
    public Uni<Response> subscribe() {
        return Uni.createFrom()
            .completionStage(sns.subscribe(s -> s.topicArn(topicArn).protocol("http").endpoint(notificationEndpoint())))
            .onItem().transform(SubscribeResponse::subscriptionArn)
            .onItem().invoke(this::setSubscriptionArn)
            .onItem().invoke(arn -> LOGGER.infov("Subscribed Quarks shield with id = {0} ", arn))
            .onItem().transform(arn -> Response.ok().entity(arn).build());
    }

    @POST
    @Path("/unsubscribe")
    public Uni<Response> unsubscribe() {
        if (subscriptionArn != null) {
            return Uni.createFrom()
                .completionStage(sns.unsubscribe(s -> s.subscriptionArn(subscriptionArn)))
                .onItem().invoke(arn -> LOGGER.infov("Unsubscribed quarks shield for id = {0}", subscriptionArn))
                .onItem().invoke(arn -> subscriptionArn = null)
                .onItem().transform(arn -> Response.ok().build());
        } else {
            return Uni.createFrom().item(Response.status(400).entity("Not subscribed yet").build());
        }
    }

    private String notificationEndpoint() {
        return quarksShieldBaseUrl + "/async/shield";
    }

    private void setSubscriptionArn(String arn) {
        this.subscriptionArn = arn;
    }

    private <T> T readObject(Class<T> clazz, String message) {
        T object = null;
        try {
            object = READERS.get(clazz).readValue(message);
        } catch (JacksonException e) {
            LOGGER.errorv("Unable to deserialize message <{0}> to Class <{1}>", message, clazz.getSimpleName());
            throw new RuntimeException(e);
        }
        return object;
    }
}

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.sns.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.

  • Do the same with the asynchronous client, using /async/shield/subscribe and /async/cannon/shoot, and unsubscribe with /async/shield/unsubscribe.

Going further

You have built a Quarkus application that uses Amazon SNS, developed locally against Dev Services and ready to run on your AWS account. You are all set to build great applications with Amazon SNS, with the fast startup, the low memory footprint and the developer joy of Quarkus.

To go further:

Configuration Reference

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

quarkus.sns.interceptors

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_SNS_INTERCEPTORS

list of string

quarkus.sns.telemetry.enabled

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

Environment variable: QUARKUS_SNS_TELEMETRY_ENABLED

boolean

true when quarkus-opentelemetry is present, false otherwise

quarkus.sns.sync-client.type

Type of the sync HTTP client implementation

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TYPE

url, apache, apache5, aws-crt

url

quarkus.sns.async-client.type

Type of the async HTTP client implementation

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TYPE

netty, aws-crt

netty

quarkus.sns.devservices.enabled

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 provider.

Environment variable: QUARKUS_SNS_DEVSERVICES_ENABLED

boolean

quarkus.sns.devservices.container-properties."container-properties"

Generic properties that are pass for additional container configuration.

Environment variable: QUARKUS_SNS_DEVSERVICES_CONTAINER_PROPERTIES__CONTAINER_PROPERTIES_

Map<String,String>

quarkus.sns.devservices.provider

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: QUARKUS_SNS_DEVSERVICES_PROVIDER

floci, localstack, ministack, moto

quarkus.sns.devservices.topics

The topics to create on startup.

Environment variable: QUARKUS_SNS_DEVSERVICES_TOPICS

list of string

AWS SDK client configurations

Type

Default

quarkus.sns.endpoint-override

quarkus.sns."client-name".endpoint-override

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_SNS_ENDPOINT_OVERRIDE

URI

quarkus.sns.api-call-timeout

quarkus.sns."client-name".api-call-timeout

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_SNS_API_CALL_TIMEOUT

Duration 

quarkus.sns.api-call-attempt-timeout

quarkus.sns."client-name".api-call-attempt-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_SNS_API_CALL_ATTEMPT_TIMEOUT

Duration 

quarkus.sns.advanced.use-quarkus-scheduled-executor-service

quarkus.sns."client-name".advanced.use-quarkus-scheduled-executor-service

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_SNS_ADVANCED_USE_QUARKUS_SCHEDULED_EXECUTOR_SERVICE

boolean

true

AWS services configurations

Type

Default

quarkus.sns.aws.region

quarkus.sns."client-name".aws.region

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.

Environment variable: QUARKUS_SNS_AWS_REGION

Region

quarkus.sns.aws.credentials.type

quarkus.sns."client-name".aws.credentials.type

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 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 Sourcing Credentials From External Processes for more information.

  • custom - Credentials are loaded from a registered bean of type AwsCredentialsProvider matching the specified name.

  • 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.

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_TYPE

default, static, system-property, env-variable, profile, container, instance-profile, process, custom, anonymous

default

Default credentials provider configuration

Type

Default

quarkus.sns.aws.credentials.default-provider.async-credential-update-enabled

quarkus.sns."client-name".aws.credentials.default-provider.async-credential-update-enabled

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_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

boolean

false

quarkus.sns.aws.credentials.default-provider.reuse-last-provider-enabled

quarkus.sns."client-name".aws.credentials.default-provider.reuse-last-provider-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_SNS_AWS_CREDENTIALS_DEFAULT_PROVIDER_REUSE_LAST_PROVIDER_ENABLED

boolean

true

Static credentials provider configuration

Type

Default

quarkus.sns.aws.credentials.static-provider.access-key-id

quarkus.sns."client-name".aws.credentials.static-provider.access-key-id

AWS Access key id

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_ACCESS_KEY_ID

string

quarkus.sns.aws.credentials.static-provider.secret-access-key

quarkus.sns."client-name".aws.credentials.static-provider.secret-access-key

AWS Secret access key

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SECRET_ACCESS_KEY

string

quarkus.sns.aws.credentials.static-provider.session-token

quarkus.sns."client-name".aws.credentials.static-provider.session-token

AWS Session token

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_STATIC_PROVIDER_SESSION_TOKEN

string

AWS Profile credentials provider configuration

Type

Default

quarkus.sns.aws.credentials.profile-provider.profile-name

quarkus.sns."client-name".aws.credentials.profile-provider.profile-name

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_SNS_AWS_CREDENTIALS_PROFILE_PROVIDER_PROFILE_NAME

string

Process credentials provider configuration

Type

Default

quarkus.sns.aws.credentials.process-provider.async-credential-update-enabled

quarkus.sns."client-name".aws.credentials.process-provider.async-credential-update-enabled

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_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_ASYNC_CREDENTIAL_UPDATE_ENABLED

boolean

false

quarkus.sns.aws.credentials.process-provider.credential-refresh-threshold

quarkus.sns."client-name".aws.credentials.process-provider.credential-refresh-threshold

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_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_CREDENTIAL_REFRESH_THRESHOLD

Duration 

15S

quarkus.sns.aws.credentials.process-provider.process-output-limit

quarkus.sns."client-name".aws.credentials.process-provider.process-output-limit

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

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_PROCESS_OUTPUT_LIMIT

MemorySize 

1M

quarkus.sns.aws.credentials.process-provider.command

quarkus.sns."client-name".aws.credentials.process-provider.command

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

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_PROCESS_PROVIDER_COMMAND

list of string

Custom credentials provider configuration

Type

Default

quarkus.sns.aws.credentials.custom-provider.name

quarkus.sns."client-name".aws.credentials.custom-provider.name

The name of custom AwsCredentialsProvider bean.

Environment variable: QUARKUS_SNS_AWS_CREDENTIALS_CUSTOM_PROVIDER_NAME

string

Sync HTTP transport configurations

Type

Default

quarkus.sns.sync-client.connection-timeout

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CONNECTION_TIMEOUT

Duration 

2S

quarkus.sns.sync-client.socket-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_SNS_SYNC_CLIENT_SOCKET_TIMEOUT

Duration 

30S

quarkus.sns.sync-client.tls-key-managers-provider.type

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 JSSE.

  • file-store - Provider that loads the key store from a file.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE

none, system-property, file-store

system-property

quarkus.sns.sync-client.tls-key-managers-provider.file-store.path

Path to the key store.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH

path

quarkus.sns.sync-client.tls-key-managers-provider.file-store.type

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_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE

string

quarkus.sns.sync-client.tls-key-managers-provider.file-store.password

Key store password

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

string

quarkus.sns.sync-client.tls-trust-managers-provider.type

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 JSSE.

  • file-store - Provider that loads the key store from a file.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE

trust-all, system-property, file-store

system-property

quarkus.sns.sync-client.tls-trust-managers-provider.file-store.path

Path to the key store.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH

path

quarkus.sns.sync-client.tls-trust-managers-provider.file-store.type

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_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE

string

quarkus.sns.sync-client.tls-trust-managers-provider.file-store.password

Key store password

Environment variable: QUARKUS_SNS_SYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

string

Apache HTTP client specific configurations

Type

Default

quarkus.sns.sync-client.apache.connection-acquisition-timeout

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_ACQUISITION_TIMEOUT

Duration 

10S

quarkus.sns.sync-client.apache.connection-max-idle-time

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_MAX_IDLE_TIME

Duration 

60S

quarkus.sns.sync-client.apache.connection-time-to-live

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_CONNECTION_TIME_TO_LIVE

Duration 

quarkus.sns.sync-client.apache.max-connections

The maximum number of connections allowed in the connection pool.

Each built HTTP client has its own private connection pool.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_MAX_CONNECTIONS

int

50

quarkus.sns.sync-client.apache.expect-continue-enabled

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_EXPECT_CONTINUE_ENABLED

boolean

true

quarkus.sns.sync-client.apache.use-idle-connection-reaper

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_SNS_SYNC_CLIENT_APACHE_USE_IDLE_CONNECTION_REAPER

boolean

true

quarkus.sns.sync-client.apache.tcp-keep-alive

Configure whether to enable or disable TCP KeepAlive.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_TCP_KEEP_ALIVE

boolean

false

quarkus.sns.sync-client.apache.proxy.enabled

Enable HTTP proxy

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_ENABLED

boolean

false

quarkus.sns.sync-client.apache.proxy.endpoint

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_SNS_SYNC_CLIENT_APACHE_PROXY_ENDPOINT

URI

quarkus.sns.sync-client.apache.proxy.username

The username to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_USERNAME

string

quarkus.sns.sync-client.apache.proxy.password

The password to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PASSWORD

string

quarkus.sns.sync-client.apache.proxy.ntlm-domain

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_DOMAIN

string

quarkus.sns.sync-client.apache.proxy.ntlm-workstation

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NTLM_WORKSTATION

string

quarkus.sns.sync-client.apache.proxy.preemptive-basic-authentication-enabled

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_PREEMPTIVE_BASIC_AUTHENTICATION_ENABLED

boolean

quarkus.sns.sync-client.apache.proxy.non-proxy-hosts

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_APACHE_PROXY_NON_PROXY_HOSTS

list of string

AWS CRT-based HTTP client specific configurations

Type

Default

quarkus.sns.sync-client.crt.connection-max-idle-time

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME

Duration 

60S

quarkus.sns.sync-client.crt.max-concurrency

The maximum number of allowed concurrent requests.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_MAX_CONCURRENCY

int

50

quarkus.sns.sync-client.crt.connection-acquisition-timeout

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

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_CONNECTION_ACQUISITION_TIMEOUT

Duration 

10S

quarkus.sns.sync-client.crt.proxy.enabled

Enable HTTP proxy

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_ENABLED

boolean

false

quarkus.sns.sync-client.crt.proxy.endpoint

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_SNS_SYNC_CLIENT_CRT_PROXY_ENDPOINT

URI

quarkus.sns.sync-client.crt.proxy.username

The username to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_USERNAME

string

quarkus.sns.sync-client.crt.proxy.password

The password to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_PROXY_PASSWORD

string

quarkus.sns.sync-client.crt.tcp-keep-alive.enabled

Configure whether to enable or disable TCP KeepAlive.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_TCP_KEEP_ALIVE_ENABLED

boolean

false

quarkus.sns.sync-client.crt.tcp-keep-alive.keep-alive-interval

Time between TCP keepalive packets being sent to the peer.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_INTERVAL

Duration 

75MS

quarkus.sns.sync-client.crt.tcp-keep-alive.keep-alive-timeout

Time to wait for a keepalive response before considering the connection timed out.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_TIMEOUT

Duration 

7200MS

quarkus.sns.sync-client.crt.tcp-keep-alive.keep-alive-probes

Number of keepalive probes allowed to fail before the connection is considered lost.

Environment variable: QUARKUS_SNS_SYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_PROBES

int

9

Async HTTP transport configurations

Type

Default

quarkus.sns.async-client.max-concurrency

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_SNS_ASYNC_CLIENT_MAX_CONCURRENCY

int

50

quarkus.sns.async-client.max-pending-connection-acquires

The maximum number of pending acquires allowed.

Once this exceeds, acquire tries will be failed.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_MAX_PENDING_CONNECTION_ACQUIRES

int

10000

quarkus.sns.async-client.read-timeout

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

Specify 0 to disable.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_READ_TIMEOUT

Duration 

30S

quarkus.sns.async-client.write-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_SNS_ASYNC_CLIENT_WRITE_TIMEOUT

Duration 

30S

quarkus.sns.async-client.connection-timeout

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIMEOUT

Duration 

10S

quarkus.sns.async-client.connection-acquisition-timeout

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_ACQUISITION_TIMEOUT

Duration 

2S

quarkus.sns.async-client.connection-time-to-live

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CONNECTION_TIME_TO_LIVE

Duration 

quarkus.sns.async-client.connection-max-idle-time

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_SNS_ASYNC_CLIENT_CONNECTION_MAX_IDLE_TIME

Duration 

5S

quarkus.sns.async-client.use-idle-connection-reaper

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_SNS_ASYNC_CLIENT_USE_IDLE_CONNECTION_REAPER

boolean

true

quarkus.sns.async-client.tcp-keep-alive

Configure whether to enable or disable TCP KeepAlive. Applicable only to netty-nio client.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TCP_KEEP_ALIVE

boolean

false

AWS CRT-based HTTP client specific configurations

Type

Default

quarkus.sns.async-client.crt.connection-max-idle-time

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_CONNECTION_MAX_IDLE_TIME

Duration 

60S

quarkus.sns.async-client.crt.max-concurrency

The maximum number of allowed concurrent requests.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_MAX_CONCURRENCY

int

50

quarkus.sns.async-client.crt.connection-acquisition-timeout

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_CONNECTION_ACQUISITION_TIMEOUT

Duration 

10S

quarkus.sns.async-client.crt.proxy.enabled

Enable HTTP proxy

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_PROXY_ENABLED

boolean

false

quarkus.sns.async-client.crt.proxy.endpoint

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_SNS_ASYNC_CLIENT_CRT_PROXY_ENDPOINT

URI

quarkus.sns.async-client.crt.proxy.username

The username to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_PROXY_USERNAME

string

quarkus.sns.async-client.crt.proxy.password

The password to use when connecting through a proxy.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_PROXY_PASSWORD

string

quarkus.sns.async-client.crt.tcp-keep-alive.enabled

Configure whether to enable or disable TCP KeepAlive.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_TCP_KEEP_ALIVE_ENABLED

boolean

false

quarkus.sns.async-client.crt.tcp-keep-alive.keep-alive-interval

Time between TCP keepalive packets being sent to the peer.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_INTERVAL

Duration 

75MS

quarkus.sns.async-client.crt.tcp-keep-alive.keep-alive-timeout

Time to wait for a keepalive response before considering the connection timed out.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_TIMEOUT

Duration 

7200MS

quarkus.sns.async-client.crt.tcp-keep-alive.keep-alive-probes

Number of keepalive probes allowed to fail before the connection is considered lost.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_CRT_TCP_KEEP_ALIVE_KEEP_ALIVE_PROBES

int

9

quarkus.sns.async-client.protocol

The HTTP protocol to use.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_PROTOCOL

http1-1, http2

http1-1

quarkus.sns.async-client.ssl-provider

The SSL Provider to be used in the Netty client.

Default is OPENSSL if available, JDK otherwise.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_SSL_PROVIDER

jdk, openssl, openssl-refcnt

quarkus.sns.async-client.http2.max-streams

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_SNS_ASYNC_CLIENT_HTTP2_MAX_STREAMS

long

4294967295

quarkus.sns.async-client.http2.initial-window-size

The initial window size for an HTTP/2 stream.

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_HTTP2_INITIAL_WINDOW_SIZE

int

1048576

quarkus.sns.async-client.http2.health-check-ping-period

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_SNS_ASYNC_CLIENT_HTTP2_HEALTH_CHECK_PING_PERIOD

Duration 

5

quarkus.sns.async-client.proxy.enabled

Enable HTTP proxy.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_PROXY_ENABLED

boolean

false

quarkus.sns.async-client.proxy.endpoint

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_SNS_ASYNC_CLIENT_PROXY_ENDPOINT

URI

quarkus.sns.async-client.proxy.non-proxy-hosts

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

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_PROXY_NON_PROXY_HOSTS

list of string

quarkus.sns.async-client.tls-key-managers-provider.type

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 JSSE.

  • file-store - Provider that loads the key store from a file.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_TYPE

none, system-property, file-store

system-property

quarkus.sns.async-client.tls-key-managers-provider.file-store.path

Path to the key store.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PATH

path

quarkus.sns.async-client.tls-key-managers-provider.file-store.type

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_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_TYPE

string

quarkus.sns.async-client.tls-key-managers-provider.file-store.password

Key store password

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_KEY_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

string

quarkus.sns.async-client.tls-trust-managers-provider.type

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 JSSE.

  • file-store - Provider that loads the key store from a file.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_TYPE

trust-all, system-property, file-store

system-property

quarkus.sns.async-client.tls-trust-managers-provider.file-store.path

Path to the key store.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PATH

path

quarkus.sns.async-client.tls-trust-managers-provider.file-store.type

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_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_TYPE

string

quarkus.sns.async-client.tls-trust-managers-provider.file-store.password

Key store password

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_TLS_TRUST_MANAGERS_PROVIDER_FILE_STORE_PASSWORD

string

quarkus.sns.async-client.event-loop.override

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: QUARKUS_SNS_ASYNC_CLIENT_EVENT_LOOP_OVERRIDE

boolean

quarkus.sns.async-client.event-loop.number-of-threads

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_SNS_ASYNC_CLIENT_EVENT_LOOP_NUMBER_OF_THREADS

int

quarkus.sns.async-client.event-loop.thread-name-prefix

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_SNS_ASYNC_CLIENT_EVENT_LOOP_THREAD_NAME_PREFIX

string

quarkus.sns.async-client.advanced.use-future-completion-thread-pool

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

When disabled, HTTP attempt completion is not offloaded to the Quarkus worker pool. Vert.x context propagation, when applicable, independently dispatches the final result to a Vert.x event loop.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_USE_FUTURE_COMPLETION_THREAD_POOL

boolean

true

quarkus.sns.async-client.advanced.vertx-context-propagation

Whether the final results of async calls made from a Vert.x event loop are delivered on the caller’s context.

When enabled, a call made from a Vert.x event loop is completed on the caller’s context. Calls made from workers (including @Blocking endpoints), virtual threads or other threads keep the SDK’s completion behavior, as configured by use-future-completion-thread-pool.

When disabled, the SDK completion behavior is kept, including the use-future-completion-thread-pool setting.

This only applies when the Quarkus Vert.x extension is present.

Environment variable: QUARKUS_SNS_ASYNC_CLIENT_ADVANCED_VERTX_CONTEXT_PROPAGATION

boolean

true
About the Duration format

To write duration values, use the standard java.time.Duration format. See the 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.
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.