/aws-parameter-store-plugin

Jenkins AWS Parameter Store Plugin

Primary LanguageJavaMIT LicenseMIT

aws-parameter-store-plugin

A Jenkins plugin to populate environment variables from AWS Parameter Store.

Overview

This plugin collects parameters from the AWS Parameter Store and sets them as environment variables for a build.

Each AWS Parameter Store parameter name is converted to uppercase and any non-numeric characters are converted to underscores. For example, the parameter name my-param_1 with value my-value-1 would become the environment variable MY_PARAM_1=my-value-1.

This plugin is compatible with AWS Parameter Store Hierarchies. A path and recursive indicator can be specified to pass to the GetParametersByPath API call. The path is removed from the variable name. A parameter name /service/param1 with value value1 and a path of /service/ would become PARAM1=value1.

  • String parameter values are unchanged
  • SecureString parameter values are decrypted
  • StringList parameter values are set as comma-separated values

Configuration

The plugin is configured on each build configuration page:

Screenshot

This has the following fields:

  • AWS Credentials - the id of credentials added via the AWS Credentials Plugin
  • AWS Region Name - the region name to search for parameters (defaults to us-east-1)
  • Path - the hierarchy for the parameters
  • Recursive - whether to retrieve all parameters within a hierarchy