Module: alb-target-group-cloudwatch-sns-alarms

Terraform module for creating alarms for tracking important changes and occurrences from ALBs.

Usage

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest, see test.

module "alb_alarms" {
  source = "cloudposse/alb-target-group-cloudwatch-sns-alarms/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"
  namespace               = "eg"
  stage                   = "staging"
  name                    = "app"
  alb_arn_suffix          = "XXXXXXXXX"
  target_group_arn_suffix = "YYYYYYYYY"
}

Requirements

Name	Version
terraform	>= 0.13.0
aws	>= 2.0

Providers

Name	Version
aws	>= 2.0

Modules

Name	Source	Version
httpcode_elb_5xx_alarm_label	cloudposse/label/null	0.25.0
httpcode_target_3xx_alarm_label	cloudposse/label/null	0.25.0
httpcode_target_4xx_alarm_label	cloudposse/label/null	0.25.0
httpcode_target_5xx_alarm_label	cloudposse/label/null	0.25.0
target_response_time_alarm_label	cloudposse/label/null	0.25.0
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_cloudwatch_metric_alarm.httpcode_elb_5xx_count	resource
aws_cloudwatch_metric_alarm.httpcode_target_3xx_count	resource
aws_cloudwatch_metric_alarm.httpcode_target_4xx_count	resource
aws_cloudwatch_metric_alarm.httpcode_target_5xx_count	resource
aws_cloudwatch_metric_alarm.target_response_time_average	resource

Inputs

Name	Description	Type	Default	Required
additional_tag_map	Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id. This is for some rare cases where resources want additional configuration of tags and therefore take a list of maps with tag key, value, and additional configuration.	map(string)	{}	no
alarm_actions	A list of ARNs (i.e. SNS Topic ARN) to execute when this alarm transitions into an ALARM state from any other state. If set, this list takes precedence over notify_arns	list(string)	[ "" ]	no
alb_arn_suffix	The ARN suffix of ALB	string	n/a	yes
attributes	ID element. Additional attributes (e.g. workers or cluster) to add to id, in the order they appear in the list. New attributes are appended to the end of the list. The elements of the list are joined by the delimiter and treated as a single ID element.	list(string)	[]	no
context	Single object for setting entire context at once. See description of individual variables for details. Leave string and numeric variables as null to use default value. Individual variable settings (non-null) override settings in context object, except for attributes, tags, and additional_tag_map, which are merged.	any	{ "additional_tag_map": {}, "attributes": [], "delimiter": null, "descriptor_formats": {}, "enabled": true, "environment": null, "id_length_limit": null, "label_key_case": null, "label_order": [], "label_value_case": null, "labels_as_tags": [ "unset" ], "name": null, "namespace": null, "regex_replace_chars": null, "stage": null, "tags": {}, "tenant": null }	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	Describe additional descriptors to be output in the descriptors output map. Map of maps. Keys are names of descriptors. Values are maps of the form {<br/> format = string<br/> labels = list(string)<br/>} (Type is any so the map values can later be enhanced to provide additional options.) format is a Terraform format string to be passed to the format() function. labels is a list of labels, in order, to pass to format() function. Label values will be normalized before being passed to format() so they will be identical to how they appear in id. Default is {} (descriptors output will be empty).	any	{}	no
elb_5xx_count_threshold	The maximum count of ELB 5XX requests over a period. A negative value will disable the alert	number	25	no
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
evaluation_periods	Number of periods to evaluate for the alarm	number	1	no
httpcode_alarm_description	The string to format and use as the httpcode alarm description	string	"HTTPCode %v count for %v over %v last %d minute(s) over %v period(s)"	no
id_length_limit	Limit id to this many characters (minimum 6). Set to 0 for unlimited length. Set to null for keep the existing setting, which defaults to 0. Does not affect id_full.	number	null	no
insufficient_data_actions	A list of ARNs (i.e. SNS Topic ARN) to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. If set, this list takes precedence over notify_arns	list(string)	[ "" ]	no
label_key_case	Controls the letter case of the tags keys (label names) for tags generated by this module. Does not affect keys of tags passed in via the tags input. Possible values: lower, title, upper. Default value: title.	string	null	no
label_order	The order in which the labels (ID elements) appear in the id. Defaults to ["namespace", "environment", "stage", "name", "attributes"]. You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.	list(string)	null	no
label_value_case	Controls the letter case of ID elements (labels) as included in id, set as tag values, and output by this module individually. Does not affect values of tags passed in via the tags input. Possible values: lower, title, upper and none (no transformation). Set this to title and set delimiter to "" to yield Pascal Case IDs. Default value: lower.	string	null	no
labels_as_tags	Set of labels (ID elements) to include as tags in the tags output. Default is to include all labels. Tags with empty values will not be included in the tags output. Set to [] to suppress all generated tags. Notes: The value of the name tag, if included, will be the id, not the name. Unlike other null-label inputs, the initial setting of labels_as_tags cannot be changed in later chained modules. Attempts to change it will be silently ignored.	set(string)	[ "default" ]	no
name	ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'. This is the only ID element not also included as a tag. The "name" tag is set to the full id string. There is no tag with the value of the name input.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
notify_arns	A list of ARNs (i.e. SNS Topic ARN) to execute when this alarm transitions into ANY state from any other state. May be overridden by the value of a more specific {alarm,ok,insufficient_data}_actions variable.	list(string)	[ "" ]	no
ok_actions	A list of ARNs (i.e. SNS Topic ARN) to execute when this alarm transitions into an OK state from any other state. If set, this list takes precedence over notify_arns	list(string)	[ "" ]	no
period	Duration in seconds to evaluate for the alarm	number	300	no
regex_replace_chars	Terraform regular expression (regex) string. Characters matching the regex will be removed from the ID elements. If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.	string	null	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
target_3xx_count_threshold	The maximum count of 3XX requests over a period. A negative value will disable the alert	number	25	no
target_4xx_count_threshold	The maximum count of 4XX requests over a period. A negative value will disable the alert	number	25	no
target_5xx_count_threshold	The maximum count of 5XX requests over a period. A negative value will disable the alert	number	25	no
target_group_arn_suffix	The ARN suffix of ALB Target Group	string	n/a	yes
target_response_time_alarm_description	The string to format and use as the target response time alarm description	string	"Target Response Time average for %v over %v last %d minute(s) over %v period(s)"	no
target_response_time_threshold	The maximum average target response time (in seconds) over a period. A negative value will disable the alert	number	0.5	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
treat_missing_data	Sets how alarms handle missing data points. Values supported: missing, ignore, breaching and notBreaching	string	"missing"	no

Outputs

Name	Description
httpcode_elb_5xx_count_cloudwatch_metric_alarm_arn	ELB 5xx count CloudWatch metric alarm ARN
httpcode_elb_5xx_count_cloudwatch_metric_alarm_id	ELB 5xx count CloudWatch metric alarm ID
httpcode_target_3xx_count_cloudwatch_metric_alarm_arn	Target Group 3xx count CloudWatch metric alarm ARN
httpcode_target_3xx_count_cloudwatch_metric_alarm_id	Target Group 3xx count CloudWatch metric alarm ID
httpcode_target_4xx_count_cloudwatch_metric_alarm_arn	Target Group 4xx count CloudWatch metric alarm ARN
httpcode_target_4xx_count_cloudwatch_metric_alarm_id	Target Group 4xx count CloudWatch metric alarm ID
httpcode_target_5xx_count_cloudwatch_metric_alarm_arn	Target Group 5xx count CloudWatch metric alarm ARN
httpcode_target_5xx_count_cloudwatch_metric_alarm_id	Target Group 5xx count CloudWatch metric alarm ID
target_response_time_average_cloudwatch_metric_alarm_arn	Target Group response time average CloudWatch metric alarm ARN
target_response_time_average_cloudwatch_metric_alarm_id	Target Group response time average CloudWatch metric alarm ID