Module: vpc-peering
Terraform module to create a peering connection between two VPCs
Screenshots
VPC Peering Connection in the AWS Web Console
Usage
For a complete example, see examples/complete.
For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.
Using VPC IDs
module "vpc_peering" {
source = "cloudposse/vpc-peering/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "dev"
name = "cluster"
requestor_vpc_id = "vpc-XXXXXXXX"
acceptor_vpc_id = "vpc-YYYYYYYY"
}
Using VPC tags
module "vpc_peering" {
source = "cloudposse/vpc-peering/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "dev"
name = "cluster"
requestor_vpc_tags = {
"kubernetes.io/cluster/my-k8s" = "owned"
}
acceptor_vpc_tags = {
Name = "legacy-vpc"
}
}
Requirements
Name | Version |
---|---|
terraform | >= 1.3 |
aws | >= 5.0 |
local | >= 1.3 |
Providers
Name | Version |
---|---|
aws | >= 5.0 |
Modules
Name | Source | Version |
---|---|---|
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_route.acceptor | resource |
aws_route.requestor | resource |
aws_vpc_peering_connection.default | resource |
aws_route_tables.acceptor | data source |
aws_route_tables.requestor | data source |
aws_vpc.acceptor | data source |
aws_vpc.requestor | data source |
Inputs
Name | Description | Type | Default | Required |
---|---|---|---|---|
acceptor_allow_remote_vpc_dns_resolution | Allow acceptor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the requestor VPC | bool | true | no |
acceptor_ignore_cidrs | A list of CIDR blocks from the acceptor VPC to ignore | list(string) | [] | no |
acceptor_route_table_tags | Only add peer routes to acceptor VPC route tables matching these tags | map(string) | {} | no |
acceptor_vpc_id | Acceptor VPC ID | string | "" | no |
acceptor_vpc_tags | Acceptor VPC tags | map(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 |
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 |
auto_accept | Automatically accept the peering (both VPCs need to be in the same AWS account) | bool | true | 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 |
| no |
create_timeout | VPC peering connection create timeout. For more details, see https://www.terraform.io/docs/configuration/resources.html#operation-timeouts | string | "3m" | no |
delete_timeout | VPC peering connection delete timeout. For more details, see https://www.terraform.io/docs/configuration/resources.html#operation-timeouts | string | "5m" | 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 beidentical 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 |
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 |
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 bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| 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 |
requestor_allow_remote_vpc_dns_resolution | Allow requestor VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the acceptor VPC | bool | true | no |
requestor_ignore_cidrs | A list of CIDR blocks from the requestor VPC to ignore | list(string) | [] | no |
requestor_route_table_tags | Only add peer routes to requestor VPC route tables matching these tags | map(string) | {} | no |
requestor_vpc_id | Requestor VPC ID | string | "" | no |
requestor_vpc_tags | Requestor VPC tags | map(string) | {} | 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 |
tenant | ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for | string | null | no |
update_timeout | VPC peering connection update timeout. For more details, see https://www.terraform.io/docs/configuration/resources.html#operation-timeouts | string | "3m" | no |
Outputs
Name | Description |
---|---|
accept_status | The status of the VPC peering connection request |
connection_id | VPC peering connection ID |