cloud-platform-terraform-canary

This Terraform module creates an AWS Synthetics Canary resource for the Cloud Platform.

Usage

See the examples/ folder.

Requirements

Name	Version
terraform	>= 0.14

Providers

Name	Version
archive	n/a
aws	n/a

Modules

No modules.

Resources

Name	Type
aws_iam_policy.canary	resource
aws_iam_role.canary	resource
aws_iam_role_policy_attachment.canary	resource
aws_synthetics_canary.main	resource
archive_file.canary_zip_inline	data source
aws_caller_identity.current	data source
aws_iam_policy_document.canary	data source
aws_iam_policy_document.canary_assume	data source
aws_region.current	data source

Inputs

Name	Description	Type	Default	Required
application	Application name	string	n/a	yes
business_unit	Area of the MOJ responsible for the service	string	""	no
canary_bucket	Module needs an existing bucket to put output in	string	n/a	yes
canary_name	The name of the canary will be prepended with team_name	string	n/a	yes
endpointpath	path - appended to the hostname for full api request	string	n/a	yes
environment	Environment name	string	n/a	yes
hostname	the hostname for the canary request	string	n/a	yes
infrastructure_support	The team responsible for managing the infrastructure. Should be of the form ()	string	n/a	yes
is_production	Whether the environment is production or not	string	"false"	no
namespace	Namespace name	string	""	no
port	port to target request on	string	n/a	yes
team_name	Team name	string	n/a	yes

Outputs

No outputs.

Tags

Some of the inputs are tags. All infrastructure resources need to be tagged according to the MOJ techincal guidance. The tags are stored as variables that you will need to fill out as part of your module.

Name	Description	Type	Default	Required
application		string	-	yes
business_unit	Area of the MOJ responsible for the service	string	mojdigital	yes
environment		string	-	yes
infrastructure_support	The team responsible for managing the infrastructure. Should be of the form team-email	string	-	yes
is_production		string	false	yes
team_name		string	-	yes

Reading Material

https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries.html