PBS TF Virtual Router 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-virtual-router-module?ref=0.0.27

Alternative Installation Methods

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

Usage

This modules provisions a basic virtual router for use in App Mesh.

Integrate this module like so:

module "router" {
  source = "github.com/pbs/terraform-aws-virtual-router-module?ref=0.0.27"

  # Required Parameters
  mesh_name = module.mesh.id

  # 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.27

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_appmesh_virtual_router.router	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
mesh_name	The name for the App Mesh this service is associated with.	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
name	Name of the virtual gateway. Will default to product if not defined.	string	null	no
port	Port the router will listen on	number	80	no
protocol	Protocol the router will listen with	string	"http"	no
tags	Extra tags	map(string)	{}	no

Outputs

Name	Description
arn	ARN of the virtual router
name	Name of the virtual router