Forge Home

aws_ssm_param

This module provides a resource type to manage parameters in the AWS SSM Parameter Store.

5,827 downloads

5,179 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.1 (latest)
  • 0.1.0
released Aug 8th 2018
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'andrewm3-aws_ssm_param', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add andrewm3-aws_ssm_param
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install andrewm3-aws_ssm_param --version 0.1.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

andrewm3/aws_ssm_param — version 0.1.1 Aug 8th 2018

aws_ssm_param

Table of Contents

  1. Description
  2. Setup - The basics of getting started with aws_ssm_param
  3. Usage - Configuration options and additional functionality
  4. Reference - An under-the-hood peek at what the module is doing and how
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module

Description

This module provides a resource type to manage parameters in the AWS SSM Parameter Store.

Setup

Setup Requirements

The type and provider requires the AWS SDK is installed into the vendored Ruby that comes with Puppet. This module does not install the package for you - if it is not installed, it can be managed with a package resource:

package { 'aws-sdk':
  ensure   => present,
  provider => puppet_gem,
}

Beginning with aws_ssm_param

When creating a parameter, you have to provide name, value and type at a minimum (where name is the fully qualified name). For example:

aws_ssm_param { '/dev/myserver/myapp/foo':
  type  => 'String',
  value => 'bar',
}

Usage

When creating a parameter, you can optionally provide some other attributes, such as description, key_id and allowed_pattern (for more information, see here). However, currently these attributes will be enforced only if the value of the parameter changes.

By default, overwrite is set to false so if the parameter already exists the value will not be overridden. To have Puppet enforce this, simply set the override attribute to true.

Limitations

This has only been tested on Ubuntu.

Development

PRs welcome.