Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

stdlib_aws

AWS management helper functions.
Project URLRSS FeedReport issues

10,538 downloads

9,839 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.3.1 (latest)
  • 0.3.0
  • 0.2.1
  • 0.0.2
released Sep 14th 2017
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 'womply-stdlib_aws', '0.3.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add womply-stdlib_aws
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install womply-stdlib_aws --version 0.3.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

womply/stdlib_aws — version 0.3.1 Sep 14th 2017

stdlib_aws

Table of Contents

  1. Description
  2. Setup - The basics of getting started with stdlib_aws
  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

stdlib_aws is a helper module containing various Puppet extensions to assist with managing resources on AWS.

For now, the only think it contains is the function stdlib_aws::subnets_from_tag, which takes a tag, optionally a tag value, and optionally a region (uses default region otherwise), and returns a list of subnet IDs for all AWS subnets tagged as described.

Setup

Setup Requirements

  1. Install AWS Ruby SDK into Puppet's Ruby on the master if it's not already present.
    • /opt/puppetlabs/puppet/bin/gem install aws-sdk
  2. Configure credentials for the gem in one of the usual ways.

Beginning with stdlib_aws

Use the functions! :D

Usage

This section is where you describe how to customize, configure, and do the fancy stuff with your module here. It's especially helpful if you include usage examples and code samples for doing things with your module.

Reference

Viewing Docs

puppetmodule.info docs

NB: puppetmodule.info is updated hourly, so please be patient after a new release!

Building Docs

  1. git clone https://github.com/womply/womply-stdlib_aws.git
  2. cd womply-stdlib_aws
  3. bundle install
  4. puppet strings generate lib/puppet/functions
  5. Open index.html in the docs/ subdirectory.

Limitations

None known.

Development

For now, just fork and make a PR!

Guidelines

Release Notes/Contributors/Etc. Optional