Skip to main content

Module: global-accelerator

This module provisions AWS Global Accelerator. Multiple listeners can be specified when instantiating this module. The endpoint-group submodule provisions a Global Accelerator Endpoint Group for a listener created by this module and can be instantiated multiple times in order to provision multiple Endpoint Groups.

The reason why endpoint-group is its own submodule is because an AWS Provider needs to be instantiated for the region the Endpoint Group's endpoints reside in. For more information, see the endpoint-group documentation.

Usage​

For a complete examples, see examples/.

The following deploys Global Accelerator with endpoints in a single region:

module "global_accelerator" {
  source = "cloudposse/global-accelerator/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  ip_address_type     = "IPV4"
  flow_logs_enabled   = true
  flow_logs_s3_prefix = "logs/"
  flow_logs_s3_bucket = module.s3_bucket.bucket_id

  listeners = [
    {
      client_affinity = "NONE"
      protocol = "TCP"
      port_ranges = [
        {
          from_port = 80
          to_port = 80
        }
      ]
    }
  ]

  context = module.this.context
}

module "endpoint_group" {
  source = "cloudposse/global-accelerator/aws//modules/endpoint-group"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  listener_arn = module.global_accelerator.listener_ids[0]
  config       = {
    endpoint_region = "us-east-2"
    endpoint_configuration = [
      {
        endpoint_lb_name = "my-load-balancer"
      }
    ]
  }

  context = module.this.context
}

The following deploys Global Accelerator with endpoints in multiple regions:

module "global_accelerator" {
  source = "cloudposse/global-accelerator/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  ip_address_type     = "IPV4"
  flow_logs_enabled   = true
  flow_logs_s3_prefix = "logs/"
  flow_logs_s3_bucket = module.s3_bucket.bucket_id

  listeners = [
    {
      client_affinity = "NONE"
      protocol = "TCP"
      port_ranges = [
        {
          from_port = 80
          to_port = 80
        }
      ]
    }
  ]

  context = module.this.context
}

module "endpoint_group" {
  source = "cloudposse/global-accelerator/aws//modules/endpoint-group"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  listener_arn = module.global_accelerator.listener_ids[0]
  config       = {
    endpoint_region = "us-east-2"
    endpoint_configuration = [
      {
        endpoint_lb_name = "my-load-balancer"
      }
    ]
  }

  context = module.this.context
}

module "endpoint_group_failover" {
  source = "cloudposse/global-accelerator/aws//modules/endpoint-group"
  # Cloud Posse recommends pinning every module to a specific version
  # version     = "x.x.x"

  listener_arn = module.global_accelerator.listener_ids[0]
  config       = {
    endpoint_region = "us-west-2"
    endpoint_configuration = [
      {
        endpoint_lb_name = "my-failover-load-balancer"
      }
    ]
  }

  providers = {
    aws = aws.failover
  }

  context = module.failover_label.context
}

Examples​

Here are some examples of using this module:

Requirements​

NameVersion
terraform>= 0.13.0
aws>= 2.0

Providers​

NameVersion
aws>= 2.0

Modules​

NameSourceVersion
thiscloudposse/label/null0.25.0

Resources​

NameType
aws_globalaccelerator_accelerator.defaultresource
aws_globalaccelerator_listener.defaultresource

Inputs​

NameDescriptionTypeDefaultRequired
additional_tag_mapAdditional 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
attributesID 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
contextSingle 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
delimiterDelimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		stringnullno
descriptor_formatsDescribe 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
enabledSet to false to prevent the module from creating any resourcesboolnullno
environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
flow_logs_enabledEnable or disable flow logs for the Global Accelerator.boolfalseno
flow_logs_s3_bucketThe name of the S3 Bucket for the Accelerator Flow Logs. Required if var.flow_logs_enabled is set to true.stringnullno
flow_logs_s3_prefixThe Object Prefix within the S3 Bucket for the Accelerator Flow Logs. Required if var.flow_logs_enabled is set to true.stringnullno
id_length_limitLimit 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.		numbernullno
ip_address_typeThe address type to use for the Global Accelerator. At this moment, only IPV4 is supported.string"IPV4"no
label_key_caseControls 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.		stringnullno
label_orderThe 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)nullno
label_value_caseControls 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.		stringnullno
labels_as_tagsSet 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
listenerslist of listeners to configure for the global accelerator.
For more information, see: aws_globalaccelerator_listener.
list(object({
    client_affinity = string
    port_ranges = list(object({
      from_port = number
      to_port   = number
    }))
    protocol = string
  }))
[]no
nameID 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.		stringnullno
namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
regex_replace_charsTerraform 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.		stringnullno
stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		map(string){}no
tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno

Outputs​

NameDescription
dns_nameDNS name of the Global Accelerator.
hosted_zone_idRoute 53 zone ID that can be used to route an Alias Resource Record Set to the Global Accelerator.
listener_idsGlobal Accelerator Listener IDs.
nameName of the Global Accelerator.
static_ipsGlobal Static IPs owned by the Global Accelerator.