AwsParameterStore.Microsoft.Extensions.Configuration
0.7.0
dotnet add package AwsParameterStore.Microsoft.Extensions.Configuration --version 0.7.0
NuGet\Install-Package AwsParameterStore.Microsoft.Extensions.Configuration -Version 0.7.0
<PackageReference Include="AwsParameterStore.Microsoft.Extensions.Configuration" Version="0.7.0" />
paket add AwsParameterStore.Microsoft.Extensions.Configuration --version 0.7.0
#r "nuget: AwsParameterStore.Microsoft.Extensions.Configuration, 0.7.0"
// Install AwsParameterStore.Microsoft.Extensions.Configuration as a Cake Addin #addin nuget:?package=AwsParameterStore.Microsoft.Extensions.Configuration&version=0.7.0 // Install AwsParameterStore.Microsoft.Extensions.Configuration as a Cake Tool #tool nuget:?package=AwsParameterStore.Microsoft.Extensions.Configuration&version=0.7.0
AwsParameterStore.Microsoft.Extensions.Configuration
AWS Systems Manager Parameter Store configuration provider implementation for Microsoft.Extensions.Configuration.
Getting Started
You should install AwsParameterStore.Microsoft.Extensions.Configuration with NuGet:
Install-Package AwsParameterStore.Microsoft.Extensions.Configuration
Or via the .NET Core command line interface:
dotnet add package AwsParameterStore.Microsoft.Extensions.Configuration
The provider is added to the ConfigurationBuilder
using the AddAwsParameterStore
extension. The default method accepts one parameter path
which is the prefix of the parameter store hierarchy.
configrationBuilder.AddAwsParameterStore("/prefix");
Hierarchical Parameters Names Mapping
Parameter Store supports parameter hierarchy. The Hierarchical values use "/" as a separator such as "/DeploymentConfig/Prod/FleetHealth". ASP.NET Core configuration normally uses colon as separator so before adding the values to the configuration we swap the forward slash "/" with colon.
Credentials
By default, AWS Access Key ID and AWS Secret Access Key are discovered from environment variables AWS_ACCESS_KEY_ID
and AWS_SECRET_ACCESS_KEY
respectively.
Required Permissions
An AWS IAM account with ssm:GetParametersByPath
permission.
Reloading secrets
Secrets are cached until IConfigurationRoot.Reload() is called. Expired, disabled, and updated secrets in the key vault are not respected by the application until Reload is executed.
Configuration.Reload();
Additional resources
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. 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 was computed. 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. |
.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 is compatible. |
.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. |
-
.NETStandard 2.0
- AWSSDK.SimpleSystemsManagement (>= 3.7.20.6)
- Microsoft.Extensions.Configuration (>= 6.0.0)
-
.NETStandard 2.1
- AWSSDK.SimpleSystemsManagement (>= 3.7.20.6)
- Microsoft.Extensions.Configuration (>= 6.0.0)
-
net6.0
- AWSSDK.SimpleSystemsManagement (>= 3.7.20.6)
- Microsoft.Extensions.Configuration (>= 6.0.0)
NuGet packages (9)
Showing the top 5 NuGet packages that depend on AwsParameterStore.Microsoft.Extensions.Configuration:
Package | Downloads |
---|---|
APF.Core.AWS
Package Description |
|
Aurionpro.PaymentFramework.Core2.1.AWS
Package Description |
|
APF.Core3.1.AWS
Package Description |
|
Aurionpro.PaymentFramework.Core3.0.AWS
Package Description |
|
Aurionpro.PaymentFramework.Core.AWS
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.