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
<PackageReference Include="Shuttle.Esb.AmazonSqs" Version="20.0.0" />
paket add Shuttle.Esb.AmazonSqs --version 20.0.0
#r "nuget: Shuttle.Esb.AmazonSqs, 20.0.0"
// 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 | Versions 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. |
-
- AWSSDK.SQS (>= 3.7.400.57)
- Shuttle.Esb (>= 20.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.