Shuttle.Esb.AmazonSqs 20.0.0

Prefix Reserved
dotnet add package Shuttle.Esb.AmazonSqs --version 20.0.0                
NuGet\Install-Package Shuttle.Esb.AmazonSqs -Version 20.0.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shuttle.Esb.AmazonSqs" Version="20.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shuttle.Esb.AmazonSqs --version 20.0.0                
#r "nuget: Shuttle.Esb.AmazonSqs, 20.0.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Shuttle.Esb.AmazonSqs as a Cake Addin
#addin nuget:?package=Shuttle.Esb.AmazonSqs&version=20.0.0

// Install Shuttle.Esb.AmazonSqs as a Cake Tool
#tool nuget:?package=Shuttle.Esb.AmazonSqs&version=20.0.0                

Amazon SQS

PM> Install-Package Shuttle.Esb.AmazonSqs

In order to make use of the AmazonSqsQueue you will need access to an Amazon Web Services account. There are some options for local development, such as ElasticMQ, which are beyond the scope of this documentation.

You may also want to take a look at Messaging Using Amazon SQS.

Configuration

The URI structure is amazonsqs://configuration-name/queue-name.

services.AddAmazonSqs(builder =>
{
    var amazonSqsOptions = new AmazonSqsOptions
    {
        ServiceUrl = "http://localhost:9324",
        MaxMessages = 1,
        WaitTime = TimeSpan.FromSeconds(20)
    };

    amazonSqsOptions.Configure += (sender, args) =>
    {
        Console.WriteLine($"[event] : Configure / Uri = '{((IQueue)sender).Uri}'");
    };

    builder.AddOptions("local", amazonSqsOptions);
});

The Configure event args arugment exposes the AmazonSQSConfig directly for any specific options that need to be set.

The default JSON settings structure is as follows:

{
  "Shuttle": {
    "AmazonSqs": {
      "local": {
        "ServiceUrl": "http://localhost:9324",
        "MaxMessages": 5,
        "WaitTime": "00:00:20"
      },
      "proper": {
        "ServiceUrl": "https://sqs.us-east-2.amazonaws.com/123456789012/MyQueue"
      }
    }
  }
}

Options

Option Default Description
ServiceUrl The URL to connect to.
MaxMessages 10 Specifies the number of messages to fetch from the queue.
WaitTime 00:00:20 Specifies the TimeSpan duration to perform long-polling.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
20.0.0 68 2/2/2025
15.0.0 89 8/5/2024
14.0.2 91 5/3/2024
14.0.1 126 4/30/2024
14.0.0 119 4/30/2024
13.2.1 392 12/1/2022
13.2.0 445 9/16/2022
13.1.0 430 9/11/2022
13.0.0 427 9/4/2022
12.0.1 486 4/9/2022
12.0.0 461 3/21/2022
11.0.1 421 1/30/2021
11.0.0 406 1/24/2021