Component: cross-region-hub-connector

This component is responsible for provisioning an AWS Transit Gateway Peering Connection to connect TGWs from different accounts and(or) regions.

Usage

Stack Level: Regional

This component is deployed to each off-region tgw/hub. meaning if your home region is region-a, and you just created a tgw/hub in region-a and region-b. To peer them, deploy this to region-b

This can be done by setting up a catalog to point to the main region, and simply importing it.

components:
  terraform:
    tgw/cross-region-hub-connector:
      vars:
        enabled: true
        account_map_tenant_name: core
        this_region:
          tgw_stage_name: network
          tgw_tenant_name: core
        home_region:
          tgw_name_format: "%s-%s"
          tgw_stage_name: network
          tgw_tenant_name: core
          environment: region-a #short or fixed notation
          region: region-a

Requirements

Name	Version
terraform	>= 1.0.0
aws	~> 4.0

Providers

Name	Version
aws.tgw_home_region	~> 4.0
aws.tgw_this_region	~> 4.0

Modules

Name	Source	Version
account_map	cloudposse/stack-config/yaml//modules/remote-state	1.4.1
iam_role_tgw_home_region	../../account-map/modules/iam-roles	n/a
iam_role_tgw_this_region	../../account-map/modules/iam-roles	n/a
iam_roles	../../account-map/modules/iam-roles	n/a
tgw_home_region	cloudposse/stack-config/yaml//modules/remote-state	1.4.1
tgw_this_region	cloudposse/stack-config/yaml//modules/remote-state	1.4.1
this	cloudposse/label/null	0.25.0

Resources

Name	Type
aws_ec2_transit_gateway_peering_attachment.tgw_peering	resource
aws_ec2_transit_gateway_peering_attachment_accepter.tgw_peering_accepter	resource
aws_ec2_transit_gateway_route_table_association.tgw_rt_associate_peering_cross_region	resource
aws_ec2_transit_gateway_route_table_association.tgw_rt_associate_peering_in_region	resource

Inputs

Name	Description	Type	Default	Required
account_map_tenant_name	The name of the tenant where account_map is provisioned. If the tenant label is not used, leave this as null.	string	null	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
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
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
home_region	Acceptors region config. Describe the transit gateway that should accept the peering	object({ tgw_name_format = string tgw_stage_name = string tgw_tenant_name = string region = string environment = string })	n/a	yes
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
import_profile_name	AWS Profile name to use when importing a resource	string	null	no
import_role_arn	IAM Role ARN to use when importing a resource	string	null	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
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
region	AWS Region	string	n/a	yes
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
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
this_region	Initiators region config. Describe the transit gateway that should originate the peering	object({ tgw_stage_name = string tgw_tenant_name = string })	n/a	yes

Outputs

Name	Description
aws_ec2_transit_gateway_peering_attachment_id	Transit Gateway Peering Attachment ID

References

• cloudposse/terraform-aws-components - Cloud Posse's upstream component