Skip to content
This repository has been archived by the owner on Apr 9, 2021. It is now read-only.
/ sfn-ssm Public archive

AWS Simple Systems Manager - Parameter Store resolver for use with sfn-parameters

License

Notifications You must be signed in to change notification settings

icariohealth/sfn-ssm

Repository files navigation

sfn-ssm

Maintainability Test Coverage

sfn-ssm is a parameter resolver used with Sparkleformation via sfn-parameters (https://github.com/sparkleformation/sfn-parameters)

Use

  1. Install this Gem where you will run Sparkleformation CLI.
  2. Provide AWS credentials following the normal AWS SDK for Ruby guidelines (https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html)
  3. Update your .sfn.rb file to include sfn-ssm in the require array.
callbacks do
    require ['sfn-parameters', 'sfn-ssm']
    default ['parameters_stacks']
  end

4.Use the Sparkleformation CLI to perform the action you desire, parameters will be filled in via Parameter Store as appropriate

Use in parameter file

Using this resolver is as simple as including parameter_store as your key name and the name of the path/value you want to lookup in Parameter Store in your sfn-parameters file.

parameters:
  stack_creator:
    parameter_store: name_to_lookup

Contributing

  1. Create a new branch based on the develop branch unless you are patching against master. We build releases from master.
  2. Make sure you have spec tests for any additions/changes
  3. Submit a meaningful PR including use case, description, etc.

Publishing a new release

  1. Follow standard practice:
    • update the gem version
    • update the changelog
    • getting approvals (Novu)
  2. Run spec tests and rubocop. Correct issues
  3. Create a PR from develop to master. Master represents the last released code.
  4. Run the sfn-ssm-publisher job when you wish to release

About

AWS Simple Systems Manager - Parameter Store resolver for use with sfn-parameters

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages