This health check verifies the ability to communicate with Amazon SNS and the existence of some topics and its subscriptions. For more information about AWS SNS check the AWS SNS Site
With all of the following examples, you can additionally add the following parameters:
name
: The health check name. Default if not specified isaws sns
.failureStatus
: TheHealthStatus
that should be reported when the health check fails. Default isHealthStatus.Unhealthy
.tags
: A list of tags that can be used to filter sets of health checks.timeout
: ASystem.TimeSpan
representing the timeout of the check.
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddTopicAndSubscriptions(options =>
{
options.AddTopic("topicName");
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddTopicAndSubscriptions(options =>
{
options.AddTopic("topicName");
options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddTopicAndSubscriptions(options =>
{
options.AddTopic("topicName");
options.RegionEndpoint = RegionEndpoint.EUCentral1;
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddTopicAndSubscriptions(options =>
{
options.AddTopic("topicName");
options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
options.RegionEndpoint = RegionEndpoint.EUCentral1;
});
}
Check existence of a topic, its subscriptions and loads credentials from the application's default configuration
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddSnsSubscriptions(options =>
{
options.AddTopicAndSubscriptions("topicName", ["subscription1-arn", "subscription2-arn"]);
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddSnsSubscriptions(options =>
{
options.AddTopicAndSubscriptions("topicName", ["subscription1-arn", "subscription2-arn"]);
options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddSnsSubscriptions(options =>
{
options.AddTopicAndSubscriptions("topicName", ["subscription1-arn", "subscription2-arn"]);
options.RegionEndpoint = RegionEndpoint.EUCentral1;
});
}
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddSnsSubscriptions(options =>
{
options.AddTopicAndSubscriptions("topicName", ["subscription1-arn", "subscription2-arn"]);
options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
options.RegionEndpoint = RegionEndpoint.EUCentral1;
});
}