amazon_aws

AWS module for management of Amazon Web Services (AWS) resources

Project URL RSS Feed Report issues

Module Stats

27,070 downloads

20,788 latest version

5.0 quality score

Version information

released Apr 1st 2019

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
Puppet >= 4.7.0 < 7.0.0
, , , , , ,

This module has been deprecated by its author since Sep 6th 2022.

Tasks:

cloudfront_aws_list_distributions2018_11_05

alexaforbusiness_aws_delete_skill_group

glue_aws_stop_crawler

iot_aws_describe_thing

iot_aws_describe_thing_group

alexaforbusiness_aws_delete_user

alexaforbusiness_aws_get_address_book

and 3298 more. See all tasks

Plans:

create_kubernetes_cluster

create_vpc_vm

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-amazon_aws', '0.3.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-amazon_aws

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-amazon_aws --version 0.3.0

Documentation

puppetlabs/amazon_aws — version 0.3.0 Apr 1st 2019

Amazon AWS

Description
Setup
- Install the module
- Validate the module
Usage
Reference
- Resources

Description

Amazon AWS exposes an API for creating and managing its Infrastructure as a Service platform. By leveraging the power of Puppet code, the module enables you to interact with the AWS API to manage your AWS resources, and provides you with the ability to run Puppet tasks on target EC2 instances.

The module is generated from the AWS API specifications and utilizes the AWS Ruby SDK. For additional information, see the AWS SDK for Ruby documentation.

Setup

Installing the module

Install the retries gem and the Amazon AWS Ruby SDK gem, using the same Ruby used by Puppet.

If using Puppet 4.x or higher, install the gems by running the following command:

/opt/puppetlabs/puppet/bin/gem install aws-sdk retries

Set the following environment variables specific to your AWS installation:

export AWS_ACCESS_KEY_ID=your_access_key_id
export AWS_SECRET_ACCESS_KEY=your_secret_access_key
export AWS_REGION=your_region

To install the module, run the following command:

puppet module install puppetlabs-amazon_aws

Validating the module

This module is compliant with the Puppet Development Kit (PDK), which provides the tool to help validate the modules's metadata, syntax, and style. When you run validations, PDK output tells you which validations it is running and notifies you of any errors or warnings it finds for each type of validation; syntax, code style, and metadata.

To run all validations against this module, run the following command:

pdk validate ruby
pdk validate metadata

To change validation behavior, add options flags to the command. For a complete list of command options and usage information, see the PDK command reference.

Usage

Create a virtual machine and subnet

Create an Ubuntu server v16.04:

aws_instances { your_vm:
  ensure             => 'present',
  image_id           => 'ami-c7e0c82c',
  min_count          => 1,
  max_count          => 1,
  key_name           => your-key-name,
  instance_type      => 't2.micro',
  subnet_id          => your-subnet-id,
  tag_specifications => [ { resource_type => "instance", tags => $tag } ]
}

Create a subnet:

aws_subnet{ your_subnet:
  name       => your_subnet,
  cidr_block => 10.9.12.0/24,
  vpc_id     => your_vpc_id,
  ensure     => present,
}

Run a task

Create a VPC:

bolt task run --nodes localhost amazon_aws::ec2_aws_create_vpc cidr_block=10.200.0.0/16

Examples

Note: Due to validation checks carried out by the Resource API, when running any example you receive a warning that states the provider returned data that did not match the Type schema for a specific resource. This warning message can be ignored. The warning is due to mismatched data between an object, and it's property.

In the examples directory you will find:

create_vm.pp to create a EC2 virtual machine.
create_subnet.pp to create a subnet for the virtual machine.
task_example.sh contains a number of sample tasks, each using Puppet Bolt:
- create and describe Amazon VPCs.
- create, list, describe, or delete an Amazon EKS cluster.
- list or delete an AWS Storage Gateway.
- create or list Amazon S3 buckets.

In the legacy examples directory are examples from the legacy module on how to create an infrastructure using this new module:

Reference

Resources

What are tasks?

Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Tasks in this module release

aaalbtg

Attaches one or more target groups to the specified Auto Scaling group. To describe the target groups for an Auto Scaling group, use DescribeLoadBalancerTargetGroups. To detach the target group from the Auto Scaling group, use DetachLoadBalancerTargetGroups. With Application Load Balancers and Network Load Balancers, instances are registered as targets with a target group. With Classic Load Balancers, instances are registered with the load balancer. For more information, see Attaching a Load Balancer to Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.

aacbrs

Creates a recurring schedule for usage reports to deliver to the specified S3 location with a specified daily or weekly interval.

Parameters
client_request_token	`Optional[String[1]]`
content_range	`Optional[String[1]]`
format	`Optional[String[1]]`
recurrence	`Optional[String[1]]`
s3_bucket_name	`Optional[String[1]]`
s3_key_prefix	`Optional[String[1]]`
schedule_name	`Optional[String[1]]`

Input method

stdin

aacibsu

Creates a URL to start an image builder streaming session.

Parameters
name	`Optional[String[1]]`
validity	`Optional[String[1]]`

aadasnt

Describes the notification types that are supported by Amazon EC2 Auto Scaling.

aadbrs

Deletes the recurring report delivery schedule with the specified schedule ARN.

Parameters
schedule_arn	`Optional[String[1]]`

aadlbtg

Detaches one or more target groups from the specified Auto Scaling group.

aadmct

Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling. The GroupStandbyInstances metric is not returned by default. You must explicitly request this metric when calling EnableMetricsCollection.

aadnc

Describes the notification actions associated with the specified Auto Scaling group.

Parameters
auto_scaling_group_names	`Optional[String[1]]`
max_records	`Optional[String[1]]`
next_token	`Optional[String[1]]`

aadrsp

Deletes room skill parameter details by room, skill, and parameter key ID.

Parameters
parameter_key	`Optional[String[1]]`
room_arn	`Optional[String[1]]`
skill_id	`Optional[String[1]]`

aadtpt

Describes the termination policies supported by Amazon EC2 Auto Scaling. For more information, see Controlling Which Auto Scaling Instances Terminate During Scale In in the Amazon EC2 Auto Scaling User Guide.

aagic

Retrieves the configured values for the user enrollment invitation email template.

aalbrs

Lists the details of the schedules that a user configured.

Parameters
max_results	`Optional[String[1]]`
next_token	`Optional[String[1]]`

aalssc

Lists all categories in the Alexa skill store.

Parameters
max_results	`Optional[String[1]]`
next_token	`Optional[String[1]]`

aalsssbc

Lists all skills in the Alexa skill store by category.

Parameters
category_id	`Optional[String[1]]`
max_results	`Optional[String[1]]`
next_token	`Optional[String[1]]`

aapic

Configures the email template for the user enrollment invitation with the specified attributes.

Parameters
contact_email	`Optional[String[1]]`
organization_name	`Optional[String[1]]`
private_skill_ids	`Optional[String[1]]`

aapsuga

Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged. For more information, see Scheduled Scaling in the Amazon EC2 Auto Scaling User Guide.

Parameters
auto_scaling_group_name	`Optional[String[1]]`
desired_capacity	`Optional[String[1]]`
end_time	`Optional[String[1]]`
max_size	`Optional[String[1]]`
min_size	`Optional[String[1]]`
recurrence	`Optional[String[1]]`
scheduled_action_name	`Optional[String[1]]`
start_time	`Optional[String[1]]`
time	`Optional[String[1]]`

Input method

stdin

aasshad

Initiates the discovery of any smart home appliances associated with the room.

Parameters
room_arn	`Optional[String[1]]`

aatiiasg

Terminates the specified instance and optionally adjusts the desired group size. This call simply makes a termination request. The instance is not terminated immediately.

Parameters
instance_id	`Optional[String[1]]`
should_decrement_desired_capacity	`Optional[String[1]]`

aaubrs

Updates the configuration of the report delivery schedule with the specified schedule ARN.

Parameters
format	`Optional[String[1]]`
recurrence	`Optional[String[1]]`
s3_bucket_name	`Optional[String[1]]`
s3_key_prefix	`Optional[String[1]]`
schedule_arn	`Optional[String[1]]`
schedule_name	`Optional[String[1]]`

Input method

stdin

acm_aws_add_tags_to_certificate

Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see Tagging ACM certificates. To remove one or more tags, use the RemoveTagsFromCertificate action. To view all of the tags that have been applied to the certificate, use the ListTagsForCertificate action.

Parameters
certificate_arn	`Optional[String[1]]`
tags	`Optional[String[1]]`

acm_aws_delete_certificate

Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the ListCertificates action or be retrieved by calling the GetCertificate action. The certificate will not be available for use by AWS services integrated with ACM. You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.

Parameters
certificate_arn	`Optional[String[1]]`

acm_aws_describe_certificate

Returns detailed metadata about the specified ACM certificate.

Parameters
certificate_arn	`Optional[String[1]]`

acm_aws_get_certificate

Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.

Parameters
certificate_arn	`Optional[String[1]]`

acm_aws_list_certificates

Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate.

Parameters
certificate_statuses	`Optional[String[1]]`
includes	`Optional[String[1]]`
max_items	`Optional[String[1]]`
next_token	`Optional[String[1]]`

acm_aws_list_tags_for_certificate

Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate action.

Parameters
certificate_arn	`Optional[String[1]]`

acm_aws_remove_tags_from_certificate

Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a certificate, use the AddTagsToCertificate action. To view all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate action.

Parameters
certificate_arn	`Optional[String[1]]`
tags	`Optional[String[1]]`

acm_aws_request_certificate

Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName parameter. You can also specify additional FQDNs in the SubjectAlternativeNames parameter. If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use DNS validation or email validation. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner.

Parameters
certificate_authority_arn	`Optional[String[1]]`
domain_name	`Optional[String[1]]`
domain_validation_options	`Optional[String[1]]`
idempotency_token	`Optional[String[1]]`
options	`Optional[String[1]]`
subject_alternative_names	`Optional[String[1]]`
validation_method	`Optional[String[1]]`

Input method

stdin

acm_aws_update_certificate_options

Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see Opting Out of Certificate Transparency Logging.

Parameters
certificate_arn	`Optional[String[1]]`
options	`Optional[String[1]]`

alexaforbusiness_aws_create_address_book

Creates an address book with the specified details.

alexaforbusiness_aws_create_conference_provider

Adds a new conference provider under the user's AWS account.

Parameters
client_request_token	`Optional[String[1]]`
conference_provider_name	`Optional[String[1]]`
conference_provider_type	`Optional[String[1]]`
ip_dial_in	`Optional[String[1]]`
meeting_setting	`Optional[String[1]]`
pstn_dial_in	`Optional[String[1]]`

Input method

stdin

What are plans?

Modules can contain plans that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.

Parameters
auto_scaling_group_name	`Optional[String[1]]`
target_group_ar_ns	`Optional[String[1]]`

Parameters
client_request_token	`Optional[String[1]]`
description	`Optional[String[1]]`
name	`Optional[String[1]]`

Modules

Discover

Contribute

Resources

About Forge

Getting Started

amazon_aws

Version information

This version is compatible with:

This module has been deprecated by its author since Sep 6th 2022.

Tasks:

Plans:

Start using this module

Documentation

Amazon AWS

Table of contents

Description

Setup

Installing the module

Validating the module

Usage

Create a virtual machine and subnet

Run a task

Examples

Reference

Resources

What are tasks?

Tasks in this module release

aaalbtg

aacbrs

aacibsu

aadasnt

aadbrs

aadlbtg

aadmct

aadnc

aadrsp

aadtpt

aagic

aalbrs

aalssc

aalsssbc

aapic

aapsuga

aasshad

aatiiasg

aaubrs

acm_aws_add_tags_to_certificate

acm_aws_delete_certificate

acm_aws_describe_certificate

acm_aws_get_certificate

acm_aws_list_certificates

acm_aws_list_tags_for_certificate

acm_aws_remove_tags_from_certificate

acm_aws_request_certificate

acm_aws_update_certificate_options

alexaforbusiness_aws_create_address_book

alexaforbusiness_aws_create_conference_provider

What are plans?

Version 0.3.0

Version 0.2.0

Version 0.1.0