AspNetCore.HealthChecks.Aws.Sqs 9.0.0

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. 
dotnet add package AspNetCore.HealthChecks.Aws.Sqs --version 9.0.0
                    


                    

                
NuGet\Install-Package AspNetCore.HealthChecks.Aws.Sqs -Version 9.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="AspNetCore.HealthChecks.Aws.Sqs" Version="9.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="AspNetCore.HealthChecks.Aws.Sqs" Version="9.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="AspNetCore.HealthChecks.Aws.Sqs" />
                    


                            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 AspNetCore.HealthChecks.Aws.Sqs --version 9.0.0
                    


                    

                
#r "nuget: AspNetCore.HealthChecks.Aws.Sqs, 9.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. 
#:package AspNetCore.HealthChecks.Aws.Sqs@9.0.0
#: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=AspNetCore.HealthChecks.Aws.Sqs&version=9.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=AspNetCore.HealthChecks.Aws.Sqs&version=9.0.0
                    


                            Install as a Cake Tool

AWS SQS Health Check

This health check verifies the ability to communicate with Amazon SQS and the existence of some queues. For more information about AWS SQS check the AWS SQS Site

Example Usage

With all of the following examples, you can additionally add the following parameters:

  • name: The health check name. Default if not specified is aws sqs.
  • failureStatus: The HealthStatus that should be reported when the health check fails. Default is HealthStatus.Unhealthy.
  • tags: A list of tags that can be used to filter sets of health checks.
  • timeout: A System.TimeSpan representing the timeout of the check.

Basic

Check existence of a queue and load credentials from the application's default configuration

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddSqs(options =>
        {
            options.AddQueue("queueName");
        });
}

Check existence of a queue and directly pass credentials

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddSqs(options =>
        {
            options.AddQueue("queueName");
            options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
        });
}

Check existence of a queue and specify region endpoint

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddSqs(options =>
        {
            options.AddQueue("queueName");
            options.RegionEndpoint = RegionEndpoint.EUCentral1;
        });
}

Check existence of a queue and specify credentials with region endpoint

public void ConfigureServices(IServiceCollection services)
{
    services
        .AddHealthChecks()
        .AddSqs(options =>
        {
            options.AddQueue("queueName");
            options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
            options.RegionEndpoint = RegionEndpoint.EUCentral1;
        });
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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.  net10.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on AspNetCore.HealthChecks.Aws.Sqs:

Package Downloads
WoW2.Sdk.Backend.Beta

WoW Two backend SDK (beta-forever mono-lib) — foundation, observability, web, mediator, identity, and data concerns in one package, divided by folders.
WoW2.Sdk.Backend.Beta.Testing.Data

WoW Two backend SDK data-tier test helpers (beta-forever) — bespoke-migrator harness, drop-schema migrator fixture, EF provider-swap, and no-op migrator wiring. References core + EF; reference from test projects only.
WoW2.Sdk.Backend.Beta.Testing.Integrations

WoW Two backend SDK integration-client test doubles (beta-forever) — configurable FakeGitHubClient and FakeContainerRegistryClient implementing the SDK's IGitHubClient / IContainerRegistryClient. Canned per-call outcomes, per-tag image existence, toggleable failure paths. References core; reference from test projects only.
RVR.Framework.HealthChecks

Health check integrations for RIVORA Framework
WoW2.Sdk.Backend.Beta.Testing.Messaging

WoW Two backend SDK messaging test harness (beta-forever) — MessagingTestHarness with published / consumed / faulted / dead-lettered assertions over the observer seam, plus an idle-wait primitive that replaces polling sleeps; and SagaTestHarness with state, transition, timeout and optimistic-concurrency assertions over a state-machine saga. References core; reference from test projects only.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
9.0.0 570,640 2024/12/19
8.0.1 398,149 2024/4/2
8.0.0 95,724 2023/12/15
7.0.0 291,433 2023/7/30
7.0.0-rc2.4 2,850 2023/3/13
7.0.0-rc2.3 294 2023/1/14
7.0.0-rc2.2 1,194 2022/12/27
7.0.0-rc2.1 276 2022/12/27
6.0.0 333,855 2022/7/4