Shuttle.Hopper.AmazonSqs 21.0.0-alpha

Prefix Reserved

This is a prerelease version of Shuttle.Hopper.AmazonSqs.

dotnet add package Shuttle.Hopper.AmazonSqs --version 21.0.0-alpha

NuGet\Install-Package Shuttle.Hopper.AmazonSqs -Version 21.0.0-alpha

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.Hopper.AmazonSqs" Version="21.0.0-alpha" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Shuttle.Hopper.AmazonSqs" Version="21.0.0-alpha" />
                    

                            Directory.Packages.props

<PackageReference Include="Shuttle.Hopper.AmazonSqs" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Shuttle.Hopper.AmazonSqs --version 21.0.0-alpha

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Shuttle.Hopper.AmazonSqs, 21.0.0-alpha"

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

#:package Shuttle.Hopper.AmazonSqs@21.0.0-alpha

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Shuttle.Hopper.AmazonSqs&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Shuttle.Hopper.AmazonSqs&version=21.0.0-alpha&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Amazon SQS

PM> Install-Package Shuttle.Hopper.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	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- AWSSDK.SQS (>= 4.0.2.8)
- Shuttle.Hopper (>= 21.0.0-alpha)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.