Healthchecks
Amazon S3
This health check verifies the ability to communicate with Amazon S3.
Installation
dotnet add package AspNetCore.Pulse.Aws.S3 --version 8.0.4
Example Usage
With all of the following examples, you can additionally add the following parameters:
name
: The health check name. Default if not specified isaws s3
.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.
Load credentials from the application’s default configuration
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddS3(options =>
{
options.BucketName = "bucket-name";
});
}
Directly pass credentials
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddS3(options =>
{
options.BucketName = "bucket-name";
options.Credentials = new BasicAWSCredentials("access-key", "secret-key");
});
}
Specify region endpoint
public void ConfigureServices(IServiceCollection services)
{
services
.AddHealthChecks()
.AddS3(options =>
{
options.BucketName = "bucket-name";
options.S3Config = new AmazonS3Config
{
RegionEndpoint = RegionEndpoint.EUCentral1
};
});
}
Was this page helpful?