Skip to content

Latest commit

 

History

History
134 lines (123 loc) · 21.4 KB

terraform.md

File metadata and controls

134 lines (123 loc) · 21.4 KB

Requirements

Name Version
terraform >= 0.13.0
aws >= 2.54, != 4.0.0, != 4.1.0, != 4.2.0, != 4.3.0, != 4.4.0, != 4.5.0, != 4.6.0, != 4.7.0, != 4.8.0
local >= 1.3
null >= 2.0

Providers

Name Version
aws >= 2.54, != 4.0.0, != 4.1.0, != 4.2.0, != 4.3.0, != 4.4.0, != 4.5.0, != 4.6.0, != 4.7.0, != 4.8.0

Modules

Name Source Version
access_logs cloudposse/lb-s3-bucket/aws 0.14.1
default_load_balancer_label cloudposse/label/null 0.25.0
default_target_group_label cloudposse/label/null 0.25.0
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_lb.default resource
aws_lb_listener.http_forward resource
aws_lb_listener.http_redirect resource
aws_lb_listener.https resource
aws_lb_listener_certificate.https_sni resource
aws_lb_target_group.default resource
aws_security_group.default resource
aws_security_group_rule.egress resource
aws_security_group_rule.http_ingress resource
aws_security_group_rule.https_ingress resource

Inputs

Name Description Type Default Required
access_logs_enabled A boolean flag to enable/disable access_logs bool true no
access_logs_prefix The S3 log bucket prefix string "" no
access_logs_s3_bucket_id An external S3 Bucket name to store access logs in. If specified, no logging bucket will be created. string null no
additional_certs A list of additonal certs to add to the https listerner list(string) [] no
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
alb_access_logs_s3_bucket_force_destroy A boolean that indicates all objects should be deleted from the ALB access logs S3 bucket so that the bucket can be destroyed without error bool false no
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
certificate_arn The ARN of the default SSL certificate for HTTPS listener 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
cross_zone_load_balancing_enabled A boolean flag to enable/disable cross zone load balancing bool true no
default_target_group_enabled Whether the default target group should be created or not. bool true no
deletion_protection_enabled A boolean flag to enable/disable deletion protection for ALB bool false no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
deregistration_delay The amount of time to wait in seconds before changing the state of a deregistering target to unused number 15 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
drop_invalid_header_fields Indicates whether HTTP headers with header fields that are not valid are removed by the load balancer (true) or routed to targets (false). bool false no
enable_glacier_transition Enables the transition of lb logs to AWS Glacier bool true 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
expiration_days Number of days after which to expunge s3 logs number 90 no
glacier_transition_days Number of days after which to move s3 logs to the glacier storage tier number 60 no
health_check_healthy_threshold The number of consecutive health checks successes required before considering an unhealthy target healthy number 2 no
health_check_interval The duration in seconds in between health checks number 15 no
health_check_matcher The HTTP response codes to indicate a healthy check string "200-399" no
health_check_path The destination for the health check request string "/" no
health_check_port The port to use for the healthcheck string "traffic-port" no
health_check_timeout The amount of time to wait in seconds before failing a health check request number 10 no
health_check_unhealthy_threshold The number of consecutive health check failures required before considering the target unhealthy number 2 no
http2_enabled A boolean flag to enable/disable HTTP/2 bool true no
http_enabled A boolean flag to enable/disable HTTP listener bool true no
http_ingress_cidr_blocks List of CIDR blocks to allow in HTTP security group list(string) 
[
  "0.0.0.0/0"
]
 no
http_ingress_prefix_list_ids List of prefix list IDs for allowing access to HTTP ingress security group list(string) [] no
http_port The port for the HTTP listener number 80 no
http_redirect A boolean flag to enable/disable HTTP redirect to HTTPS bool false no
https_enabled A boolean flag to enable/disable HTTPS listener bool false no
https_ingress_cidr_blocks List of CIDR blocks to allow in HTTPS security group list(string) 
[
  "0.0.0.0/0"
]
 no
https_ingress_prefix_list_ids List of prefix list IDs for allowing access to HTTPS ingress security group list(string) [] no
https_port The port for the HTTPS listener number 443 no
https_ssl_policy The name of the SSL Policy for the listener string "ELBSecurityPolicy-2015-05" 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
idle_timeout The time in seconds that the connection is allowed to be idle number 60 no
internal A boolean flag to determine whether the ALB should be internal bool false no
ip_address_type The type of IP addresses used by the subnets for your load balancer. The possible values are ipv4 and dualstack. string "ipv4" 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
lifecycle_rule_enabled A boolean that indicates whether the s3 log bucket lifecycle rule should be enabled. bool false no
listener_http_fixed_response Have the HTTP listener return a fixed response for the default action. 
object({
    content_type = string
    message_body = string
    status_code  = string
  })
 null no
listener_https_fixed_response Have the HTTPS listener return a fixed response for the default action. 
object({
    content_type = string
    message_body = string
    status_code  = string
  })
 null no
load_balancer_name The name for the default load balancer, uses a module label name if left empty string "" no
load_balancer_name_max_length The max length of characters for the load balancer. number 32 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
noncurrent_version_expiration_days Specifies when noncurrent s3 log versions expire number 90 no
noncurrent_version_transition_days Specifies when noncurrent s3 log versions transition number 30 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
security_group_enabled Enables the security group bool true no
security_group_ids A list of additional security group IDs to allow access to ALB list(string) [] no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
standard_transition_days Number of days to persist logs in standard storage tier before moving to the infrequent access tier number 30 no
stickiness Target group sticky configuration 
object({
    cookie_duration = number
    enabled         = bool
  })
 null no
subnet_ids A list of subnet IDs to associate with ALB list(string) n/a yes
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_group_additional_tags The additional tags to apply to the target group map(string) {} no
target_group_name The name for the default target group, uses a module label name if left empty string "" no
target_group_name_max_length The max length of characters for the target group. number 32 no
target_group_port The port for the default target group number 80 no
target_group_protocol The protocol for the default target group HTTP or HTTPS string "HTTP" no
target_group_target_type The type (instance, ip or lambda) of targets that can be registered with the target group string "ip" 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
vpc_id VPC ID to associate with ALB string n/a yes

Outputs

Name Description
access_logs_bucket_id The S3 bucket ID for access logs
alb_arn The ARN of the ALB
alb_arn_suffix The ARN suffix of the ALB
alb_dns_name DNS name of ALB
alb_name The ARN suffix of the ALB
alb_zone_id The ID of the zone which ALB is provisioned
default_target_group_arn The default target group ARN
http_listener_arn The ARN of the HTTP forwarding listener
http_redirect_listener_arn The ARN of the HTTP to HTTPS redirect listener
https_listener_arn The ARN of the HTTPS listener
listener_arns A list of all the listener ARNs
security_group_id The security group ID of the ALB