PBS TF Resource Group Module

Installation

Using the Repo Source

Use this URL for the source of the module. See the usage examples below for more details.

github.com/pbs/terraform-aws-resource-group-module?ref=0.0.16

Alternative Installation Methods

More information can be found on these install methods and more in the documentation here.

Usage

Creates an AWS Resource Group group.

By default, the module will group together all resources that are tagged with the standard tags that are required on all PBS AWS Terraform modules that support tags. This can be overridden by populating the query variable with a valid AWS Resource Group query.

Integrate this module like so:

module "resource_group" {
  source = "github.com/pbs/terraform-aws-resource-group-module?ref=0.0.16"

  # Tagging Parameters
  organization = var.organization
  environment  = var.environment
  product      = var.product
  repo         = var.repo

  # Optional Parameters
}

Adding This Version of the Module

If this repo is added as a subtree, then the version of the module should be close to the version shown here:

0.0.16

Note, however that subtrees can be altered as desired within repositories.

Further documentation on usage can be found here.

Below is automatically generated documentation on this Terraform module using terraform-docs

---

Requirements

Name	Version
terraform	>= 1.3.2
aws	>= 4.5.0

Providers

Name	Version
aws	5.24.0

Modules

No modules.

Resources

Name	Type
aws_resourcegroups_group.group	resource
aws_default_tags.common_tags	data source

Inputs

Name	Description	Type	Default	Required
environment	Environment (sharedtools, dev, staging, qa, prod)	string	n/a	yes
organization	Organization using this module. Used to prefix tags so that they are easily identified as being from your organization	string	n/a	yes
product	Tag used to group resources according to product	string	n/a	yes
repo	Tag used to point to the repo using this module	string	n/a	yes
description	Description of the resource group module.	string	null	no
name	Name of the resource group module. If null, will default to product.	string	null	no
query	Query to use for the resource group. If null, will default to all supported resources for the product.	string	null	no
tags	Extra tags	map(string)	{}	no

Outputs

Name	Description
arn	ARN of the resource group.
name	Name of the resource group.