Google Compute Engine Router Peer

This page shows how to write Terraform for Compute Engine Router Peer and write them securely.

google_compute_router_peer (Terraform)

The Router Peer in Compute Engine can be configured in Terraform with the resource name google_compute_router_peer. The following sections describe 3 examples of how to use the resource and its parameters.

Example Usage from GitHub

resource "google_compute_router_peer" "gcve_router_peer1" {
  name                      = "gcve-router-peer1"
  router                    =
  region                    = var.region
  peer_ip_address           = ""
  peer_asn                  = 64515
resource "google_compute_router_peer" "router1_peer1" {
  name                      = "router1-peer1"
  router                    =
  region                    = "us-central1"
  peer_ip_address           = ""
  peer_asn                  = 64515
resource "google_compute_router_peer" "router1_peer1" {
  provider         = "google-beta"
  project     = var.gcp_project_id
  name                      = var.bgp_peer_1
  router                    = var.cloud_router
  region                    = var.gcp_region


  • advertise_mode optional - string
    • User-specified flag to indicate which mode to use for advertisement. Valid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"]

  • advertised_groups optional - list / string
    • User-specified list of prefix groups to advertise in custom mode, which can take one of the following options: 'ALL_SUBNETS': Advertises all available subnets, including peer VPC subnets. 'ALL_VPC_SUBNETS': Advertises the router's own VPC subnets. * 'ALL_PEER_VPC_SUBNETS': Advertises peer subnets of the router's VPC network. Note that this field can only be populated if advertiseMode is 'CUSTOM' and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups.

  • advertised_route_priority optional - number
    • The priority of routes advertised to this BGP peer. Where there is more than one matching route of maximum length, the routes with the lowest priority value win.

  • id optionalcomputed - string
  • interface required - string
    • Name of the interface the BGP peer is associated with.

  • ip_address requiredcomputed - string
    • IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

  • management_type requiredcomputed - string
    • The resource that configures and manages this BGP peer. 'MANAGED_BY_USER' is the default value and can be managed by you or other users 'MANAGED_BY_ATTACHMENT' is a BGP peer that is configured and managed by Cloud Interconnect, specifically by an InterconnectAttachment of type PARTNER. Google automatically creates, updates, and deletes this type of BGP peer when the PARTNER InterconnectAttachment is created, updated, or deleted.

  • name required - string
    • Name of this BGP peer. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression 'a-z?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

  • peer_asn required - number
    • Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

  • peer_ip_address required - string
    • IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported.

  • project optionalcomputed - string
  • region optionalcomputed - string
    • Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

  • router required - string
    • The name of the Cloud Router in which this BgpPeer will be configured.

Explanation in Terraform Registry

BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. To get more information about RouterBgpPeer, see:

Frequently asked questions

What is Google Compute Engine Router Peer?

Google Compute Engine Router Peer is a resource for Compute Engine of Google Cloud Platform. Settings can be wrote in Terraform.

Where can I find the example code for the Google Compute Engine Router Peer?

For Terraform, the PacketBeta/gcve-cloudvpn-transit-vpc, TanAlex/gcp-terraform-sample and tranquilitybase-io/tb-module-gcp-aws-vpn source code examples are useful. See the Terraform Example section for further details.


Scan your IaC problem in 3 minutes for free

You can keep your IaC security for free. No credit card required.