Alvecta.Foundation.Infrastructure.AmazonSsm 7.0.65

There is a newer version of this package available.
See the version list below for details.

dotnet add package Alvecta.Foundation.Infrastructure.AmazonSsm --version 7.0.65

NuGet\Install-Package Alvecta.Foundation.Infrastructure.AmazonSsm -Version 7.0.65

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Alvecta.Foundation.Infrastructure.AmazonSsm" Version="7.0.65" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Alvecta.Foundation.Infrastructure.AmazonSsm" Version="7.0.65" />
                    

                            Directory.Packages.props

<PackageReference Include="Alvecta.Foundation.Infrastructure.AmazonSsm" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Alvecta.Foundation.Infrastructure.AmazonSsm --version 7.0.65

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Alvecta.Foundation.Infrastructure.AmazonSsm, 7.0.65"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Alvecta.Foundation.Infrastructure.AmazonSsm@7.0.65

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Alvecta.Foundation.Infrastructure.AmazonSsm&version=7.0.65
                    

                            Install as a Cake Addin

#tool nuget:?package=Alvecta.Foundation.Infrastructure.AmazonSsm&version=7.0.65
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Alvecta.Foundation.Infrastructure.AmazonSsm

An ISecretProvider (from Alvecta.Foundation.Infrastructure.Secrets) backed by AWS Systems Manager Parameter Store, so secret:<parameter-name> configuration values resolve to SSM parameters at startup.

It belongs to the Infrastructure layer. Dependencies: Alvecta.Foundation.Infrastructure.Secrets, Alvecta.Utils, AWSSDK.Core and AWSSDK.SimpleSystemsManagement.

What it contains

SsmSecretProvider — reads the requested parameters with GetParameters, one call per ten names (the most one call accepts), decrypting SecureString values. It throws an InvalidOperationException naming every parameter that does not exist.
SsmStartup.ResolveSecretsAsync(IConfigurationManager, CancellationToken) — creates an SSM client from the default AWS configuration (region and credentials from the environment), resolves every secret: value through SsmSecretProvider, and disposes the client.

Usage

dotnet add package Alvecta.Foundation.Infrastructure.AmazonSsm

Write secret references as full SSM parameter names:

{
  "Payments": {
    "ApiKey": "secret:/ProdShop/PaymentsApiKey"
  }
}

Resolve them first thing in the composition root, before anything reads configuration:

using Alvecta.Foundation.Infrastructure.AmazonSsm;

var builder = WebApplication.CreateBuilder(args);

await SsmStartup.ResolveSecretsAsync(builder.Configuration, CancellationToken.None);

// Register services as usual; they see the decrypted values.

The process needs ssm:GetParameters on the referenced parameters (and kms:Decrypt when they are encrypted with a customer-managed key). Alvecta.Foundation.Deployment.Cdk grants SSM access under the environment's parameter prefix, and creates each referenced parameter that does not exist yet as a SecureString holding the placeholder default, for you to overwrite with the real value.

To use your own SSM client (a specific region, a mocked client in tests), call the Alvecta.Foundation.Infrastructure.Secrets extension directly:

await builder.Configuration.ResolveSecretsAsync(new SsmSecretProvider(ssmClient), cancellationToken);

Product	Compatible and additional computed target framework versions.
.NET	net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- Alvecta.Foundation.Infrastructure.Secrets (>= 7.0.65)
- Alvecta.Utils (>= 8.0.66)
- AWSSDK.Core (>= 4.0.102.11)
- AWSSDK.SimpleSystemsManagement (>= 4.0.104.4)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.