CatConsult.AppConfigConfigurationProvider 2.0.0-beta

AWS AppConfig Configuration Provider for .NET

An opinionated .NET Configuration Provider for AWS AppConfig.

Usage

First, download the provider from NuGet:

dotnet add package CatConsult.AppConfigConfigurationProvider

Then add the provider using the AddAppConfig extension method:

builder.Configuration.AddAppConfig();

By default, the provider will look for a configuration section named AppConfig. This can be overriden by specifying a different section name:

builder.Configuration.AddAppConfig("MyCustomName");

Configuration

The provider requires some minimal configuration in order for it to know which AppConfig profiles to load:

{
  "AppConfig": {
    "Profiles": [
      "abc1234:def5678:ghi9123",
      "q2w3e25:po92j45:bt9s090:300"
    ]
  }
}

As you can see in the example above, the AppConfig metadata are encoded as a formatted string:

ApplicationId:EnvironmentId:ProfileId[:ReloadAfter]

ReloadAfter is an optional 4th parameter that configures the reload/refresh period. It is an integer that represents time in seconds. If not specified, it defaults to the provider's default setting, which is 90 seconds.

The default ReloadAfter setting can be overridden as well:

{
  "AppConfig": {
    "Defaults": {
      "ReloadAfter": 120
    }
  }
}

Sample

A sample ASP.NET Web Application is available in the samples/AppConfigTesting folder.

In your own AWS environment, copy the contents of yamltest.yml into a new AppConfig freeform configuration profile.

Then, use dotnet user-secrets to specify the AppConfig profile:

dotnet user-secrets set "AppConfig:Profiles:0" "abc1234:def5678:ghi9123"

Finally, ensure that you have the correct AWS credentials/profile configured in your environment, and run the sample:

dotnet run

Experiment by changing the configuration on AppConfig and deploying. After a while, you should see the application reload the configuration automatically when you refresh the home page.