FxMap.Aws.Sqs 4.1.1

<p align="center"> <img src="https://raw.githubusercontent.com/quyvu01/FxMap/main/FxMap.png" alt="FxMap" width="96" /> </p>

<h1 align="center">FxMap.Aws.Sqs</h1>

<p align="center"> Amazon SQS transport for FxMap — request/response between services over SQS queues. </p>

<p align="center"> <a href="https://www.nuget.org/packages/FxMap.Aws.Sqs"><img alt="NuGet" src="https://img.shields.io/nuget/v/FxMap.Aws.Sqs.svg" /></a> <a href="https://www.nuget.org/packages/FxMap.Aws.Sqs"><img alt="Downloads" src="https://img.shields.io/nuget/dt/FxMap.Aws.Sqs.svg" /></a> <a href="https://github.com/quyvu01/FxMap/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-Apache--2.0-blue.svg" /></a> </p>

<p align="center"> <a href="https://github.com/quyvu01/FxMap"><b>FxMap</b></a> · <a href="https://fxmapper.net"><b>Documentation</b></a> · <a href="https://github.com/quyvu01/TestFxMap-Demo"><b>Demo project</b></a> </p>

A transport carries FxMap requests between the service that needs data (the client) and the service that owns it (the server). Every service that maps data needs the core FxMap package; the owning service also needs a data provider (EntityFrameworkCore or MongoDb), and both sides use the same transport. Requests are batched per distributed key, so a hundred objects that need a UserName produce one request.

The SQS transport uses long polling and batch processing, and a supervisor restarts a failing consumer. A process shares one AmazonSQSClient between its client and its server.

Installation

dotnet add package FxMap.Aws.Sqs

Usage

builder.Services.AddFxMap(cfg =>
{
    cfg.AddEntitiesFromAssemblyContaining<SomeEntityAssemblyMarker>();
    cfg.AddProfilesFromAssemblyContaining<SomeProfileAssemblyMarker>();
    cfg.AddSqs(sqs => sqs.Region(RegionEndpoint.USEast1, credential =>
    {
        credential.AccessKeyId("your-access-key-id");
        credential.SecretAccessKey("your-secret-access-key");
    }));
});

IAM roles (recommended on AWS): omit the credentials and the client uses the default AWS credentials of the environment, such as the IAM role of the instance or container.

cfg.AddSqs(sqs => sqs.Region(RegionEndpoint.USEast1));

LocalStack (local development):

cfg.AddSqs(sqs => sqs.Region(RegionEndpoint.USEast1, credential =>
{
    credential.ServiceUrl("http://localhost:4566");
    credential.AccessKeyId("test");
    credential.SecretAccessKey("test");
}));

Naming

Requests go to the queue fxmap-{namespace}-{type name} (dots replaced by hyphens, lower case). Each client creates a response queue fxmap-response-{machine name}-{guid}. Avoid using these names for anything else.

Related packages