NetEvolve.HealthChecks.AWS.SNS 4.3.0

NetEvolve.HealthChecks.AWS.SNS

This package provides a health check for AWS Simple Notification Service (SNS), based on the AWS SDK for .NET package. The main purpose is to check that the SNS service is reachable and that the client can connect to it.

💡 This package is available for .NET 6.0 and later.

Installation

To use this package, you need to add the package to your project. You can do this by using the NuGet package manager or by using the dotnet CLI.

dotnet add package NetEvolve.HealthChecks.AWS.SNS

Health Check - AWS SNS Liveness

The health check is a liveness check. It will check that the SNS service is reachable and that the client can connect to it. If the service needs longer than the configured timeout to respond, the health check will return Degraded. If the service is not reachable, the health check will return Unhealthy.

Usage

After adding the package, you need to import the namespace NetEvolve.HealthChecks.AWS.SNS and add the health check to the service collection.

using NetEvolve.HealthChecks.AWS.SNS;

Therefore, you can use two different approaches. In both approaches you have to provide a name for the health check.

Parameters

• name: The name of the health check. The name is used to identify the configuration object. It is required and must be unique within the application.
• options: The configuration options for the health check. If you don't provide any options, the health check will use the configuration based approach.
• tags: The tags for the health check. The tags aws and sns are always used as default and combined with the user input. You can provide additional tags to group or filter the health checks.

Variant 1: Configuration based

The first one is to use the configuration based approach. Therefore, you have to add the configuration section HealthChecks:AWSSNS to your appsettings.json file.

var builder = services.AddHealthChecks();

builder.AddSimpleNotificationService("<name>");

The configuration looks like this:

{
    ..., // other configuration
    "HealthChecks": {
        "AWSSNS": {
            "<name>": {
                "Region": "<aws-region>", // optional, uses default AWS region if not specified
                "AccessKey": "<access-key>", // optional, uses default AWS credentials if not specified
                "SecretKey": "<secret-key>", // optional, uses default AWS credentials if not specified
                "TopicArn": "<topic-arn>", // required
                "Timeout": "<timeout>" // optional, default is 100 milliseconds
            }
        }
    }
}

Variant 2: Builder based

The second approach is to use the builder based approach. This approach is recommended if you have only one SNS topic to check or dynamic programmatic values.

var builder = services.AddHealthChecks();

builder.AddSimpleNotificationService("<name>", options =>
{
        options.TopicArn = "<topic-arn>"; // required
        options.Region = "<aws-region>"; // optional, uses default AWS region if not specified
        options.AccessKey = "<access-key>"; // optional, uses default AWS credentials if not specified
        options.SecretKey = "<secret-key>"; // optional, uses default AWS credentials if not specified
        options.Timeout = "<timeout>"; // optional, default is 100 milliseconds
        ... // other configuration
});

💡 You can always provide tags to all health checks, for grouping or filtering.

var builder = services.AddHealthChecks();

builder.AddSimpleNotificationService("<name>", options => ..., "sns");