eonx-com/easy-ssm

CLI tool to interact with AWS ParameterStore in a convenient way

4.5.6 2024-09-19 04:45 UTC

Requires

• php: ^8.1
• aws/aws-sdk-php: ^3.134
• eonx-com/easy-aws-credentials-finder: ^4.5.6
• eonx-com/easy-random: ^4.5.6
• nette/utils: ^3.1
• symfony/dotenv: ^5.4 || ^6.0
• symfony/http-kernel: ^5.4 || ^6.0
• symfony/yaml: ^5.4 || ^6.0

Requires (Dev)

• phpunit/phpunit: ^9.5 || ^10.0

MIT

README

---eonx_docs--- title: Introduction weight: 0 ---eonx_docs---

CLI tool to interact with AWS ParameterStore in a convenient way

Require package (Composer)

We recommend to use Composer to manage your dependencies. You can require this package as follows:

$ composer require eonx-com/easy-ssm

Commands

• apply: Apply local changes to remote AWS ParameterStore
• diff: Resolve diff between local parameters and AWS ParameterStore
• dump-envs: Dump env vars in a PHP file to improve loading time
• export-envs: Fetch parameters from AWS ParameterStore and output shell syntax to export them as env variables
• init: Initialise local parameters from AWS ParameterStore
• local-apply: Apply changes locally when "*_old" file has been generated
• local-diff: Resolve diff locally when "*_old" file has been generated

Dotenv integration

If working on a PHP project, you can use the Dotenv integration provided by this package to load your AWS ParameterStore parameters as env variables within PHP:

// bootstrap.php

require_once __DIR__ . '/vendor/autoload.php';

// Will fetch parameters from AWS ParameterStore and export them as env vars
(new \EonX\EasySsm\Dotenv\SsmDotenv())->loadEnv();

// Now your parameters from AWS ParameterStore are available in: $_ENV, $_SERVER and via \getenv()