Skip to content

Pydantic Settings AWS

CI codecov PyPI - Implementation PyPI - Python Version Pydantic v2 only PyPI - License Downloads

Pydantic Settings AWS is an extension of the great 🚀 Pydantic Settings library.

It offers an easy way to load your settings hosted in ☁️ AWS Secrets Manager and Parameter Store.

Installation

You can install pydantic-settings-aws with pip:

pip install pydantic-settings-aws

pydantic-settings-aws will install some dependencies for you:

  • pydantic >= 2.0.1
  • pydantic-settings >= 2.0.2
  • boto3 >= 1.27.0
  • boto3-stubs[secretsmanager] >= 1.27.0

Usage

Using pydantic-settings-aws can be as easy as:

settings.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# import pydantic_settings_aws
from pydantic_settings_aws import SecretsManagerBaseSettings


class AWSSecretsSettings(SecretsManagerBaseSettings):
    model_config = SettingsConfigDict(
        secrets_name="my/secret" # just put your secrets manager name
    )

    username: str
    password: str


settings = AWSSecretsSettings()
settings.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
import boto3
from pydantic_settings_aws import SecretsManagerBaseSettings

client = boto3.client("secretsmanager")


class AWSSecretsSettings(SecretsManagerBaseSettings):
    model_config = SettingsConfigDict(
        secrets_name="my/secret", # just put your secrets manager name
        secrets_client=client # pass your already created boto3 client
    )

    username: str
    password: str


settings = AWSSecretsSettings()
settings.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
from pydantic_settings_aws import SecretsManagerBaseSettings


class AWSSecretsSettings(SecretsManagerBaseSettings):
    model_config = SettingsConfigDict(
        aws_region="us-east-1",
        aws_profile="dev"
    )

    username: str
    password: str


settings = AWSSecretsSettings()