FxMap.Aws.Sqs 2.0.1

FxMap.Aws.Sqs

FxMap.Aws.Sqs is an extension package for FxMap that leverages Amazon SQS for efficient data transportation. This package provides a high-performance, strongly-typed communication layer for FxMap's FluentAPI-based Data Mapping, enabling streamlined data retrieval across distributed systems.

Demo Project!

Introduction

Amazon SQS-based Transport: Implements Amazon SQS to handle data communication between services, providing a fast, secure, and scalable solution with features like long polling, batch processing, and automatic supervision.

Installation

To install the FxMap.Aws.Sqs package, use the following NuGet command:

dotnet add package FxMap.Aws.Sqs

Or via the NuGet Package Manager:

Install-Package FxMap.Aws.Sqs

How to Use

1. Register FxMap.Aws.Sqs

Add FxMap.Aws.Sqs to your service configuration during application startup:

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");
        });
    });
});

...

var app = builder.Build();

app.Run();

LocalStack Support (for testing)

builder.Services.AddFxMap(cfg =>
{
    cfg.AddEntitiesFromAssemblyContaining<SomeEntityAssemblyMarker>();
    cfg.AddProfilesFromAssemblyContaining<SomeProfileAssemblyMarker>();
    cfg.AddSqs(sqs =>
    {
        sqs.Region(RegionEndpoint.USEast1, credential =>
        {
            credential.ServiceUrl("http://localhost:4566"); // LocalStack endpoint
            credential.AccessKeyId("test");
            credential.SecretAccessKey("test");
        });
    });
});

Using IAM Roles (recommended for AWS environments)

builder.Services.AddFxMap(cfg =>
{
    cfg.AddEntitiesFromAssemblyContaining<SomeEntityAssemblyMarker>();
    cfg.AddProfilesFromAssemblyContaining<SomeProfileAssemblyMarker>();
    cfg.AddSqs(sqs =>
    {
        sqs.Region(RegionEndpoint.USEast1); // No credentials needed, uses IAM role
    });
});

Note: FxMap.Aws.Sqs uses queues that start with fxmap-{namespace}-{distributedkeyname}. Therefore, you should avoid using other queues. Additionally, FxMap.Aws.Sqs automatically creates response queues fxmap-response-{machinename}-{guid}, so you should avoid creating a queue with the same name in your application.

That All, enjoy your moment!