Google Compute Engine Router

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

google_compute_router (Terraform)

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

Example Usage from GitHub

cloudRouter.tf#L2
resource "google_compute_router" "nat-router-usce1" {
    name = "nat-router-usce1"
    network = "default"
    region = "us-central1"

}
routers.tf#L3
resource "google_compute_router" "router-subnetwork-1" {
  name    = "router-subnetwork-1"
  region  = google_compute_subnetwork.subnetwork-1.region
  network = google_compute_network.shared-vpc.id

  depends_on = [
network.tf#L17
resource "google_compute_router" "mgmt_router" {
  name    = "mgmt-router"
  region  = var.region
  network = google_compute_network.mgmt_vpc.self_link

  bgp {

Review your Terraform file for Google best practices

Shisho Cloud, our free checker to make sure your Terraform configuration follows best practices, is available (beta).

Parameters

Creation timestamp in RFC3339 text format.

An optional description of this resource.

  • id optional computed - string
  • name required - string

Name of the resource. 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.

A reference to the network to which this router belongs.

Region where the router resides.

  • self_link optional computed - string
  • bgp list block

    User-specified flag to indicate which mode to use for advertisement. Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"]

    User-specified list of prefix groups to advertise in custom mode. This field can only be populated if advertiseMode is CUSTOM and is advertised to all peers of the router. These groups will be advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. This enum field has the one valid value: ALL_SUBNETS

    • asn required - number

    Local BGP Autonomous System Number (ASN). Must be an RFC6996 private ASN, either 16-bit or 32-bit. The value will be fixed for this router resource. All VPN tunnels that link to this router will have the same local ASN.

    • advertised_ip_ranges list block

      User-specified description for the IP range.

      The IP range to advertise. The value must be a CIDR-formatted string.

  • timeouts single block

Explanation in Terraform Registry

Represents a Router resource. To get more information about Router, see:

Tips: Best Practices for The Other Google Compute Engine Resources

In addition to the google_compute_disk, Google Compute Engine has the other resources that should be configured for security reasons. Please check some examples of those resources and precautions.

risk-label

google_compute_disk

Ensure the encryption key for your GCE disk is stored securely

It is better to store the encryption key for your GCE disk securely. Secret Manager could be used instead.

risk-label

google_compute_firewall

Ensure your VPC firewall blocks unwanted outbound traffic

It is better to block unwanted outbound traffic not to expose resources in the VPC to unwanted attacks.

risk-label

google_compute_instance

Ensure appropriate service account is assigned to your GCE instance

It is better to create a custom service account for the instance and assign it.

risk-label

google_compute_project_metadata

Ensure OS login for your GCE instances is enabled at project level

It is better to enable OS login for your GCE instances. Enabling OS login ensures that SSH keys used to connect to instances are mapped with IAM users, allowing centralized and automated SSH key management.

risk-label

google_compute_ssl_policy

Ensure to use modern TLS protocols

It's better to adopt TLS v1.2+ instead of outdated TLS protocols.

risk-label

google_compute_subnetwork

Ensure VPC flow logging is enabled

It is better to enable VPC flow logging. VPC flow logging allows us to audit traffic in your network.

Review your Google Compute Engine settings

In addition to the above, there are other security points you should be aware of making sure that your .tf files are protected in Shisho Cloud.

Frequently asked questions

What is Google Compute Engine Router?

Google Compute Engine Router 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?

For Terraform, the jonathanpaliza/gcloudProjects, seanmccorkle/terraform-gcp and boreal321/terraform-bigip-gcp source code examples are useful. See the Terraform Example section for further details.

security-icon

Automate config file reviews on your commits

Fix issues in your infrastructure as code with auto-generated patches.