Google Compute Engine Service Attachment

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

google_compute_service_attachment (Terraform)

The Service Attachment in Compute Engine can be configured in Terraform with the resource name google_compute_service_attachment. The following sections describe how to use the resource and its parameters.

Example Usage from GitHub

An example could not be found in GitHub.

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).


The following arguments are supported:

  • name - (Required) 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]([-a-z0-9]*[a-z0-9])? 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.

  • connection_preference - (Required) The connection preference to use for this service attachment. Valid values include "ACCEPT_AUTOMATIC", "ACCEPT_MANUAL".

  • target_service - (Required) The URL of a forwarding rule that represents the service identified by this service attachment.

  • nat_subnets - (Required) An array of subnets that is provided for NAT in this service attachment.

  • enable_proxy_protocol - (Required) If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers.

  • description - (Optional) An optional description of this resource.

  • consumer_reject_lists - (Optional) An array of projects that are not allowed to connect to this service attachment.

  • consumer_accept_lists - (Optional) An array of projects that are allowed to connect to this service attachment. Structure is documented below.

  • region - (Optional) URL of the region where the resource resides.

  • project - (Optional) The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The consumer_accept_lists block supports:

  • project_id_or_num - (Required) A project that is allowed to connect to this service attachment.

  • connection_limit - (Required) The number of consumer forwarding rules the consumer project can create.

In addition to the arguments listed above, the following computed attributes are exported:

  • id - an identifier for the resource with format projects/[[project]]/regions/[[region]]/serviceAttachments/[[name]]

  • fingerprint - Fingerprint of this resource. This field is used internally during updates of this resource.

  • connected_endpoints - An array of the consumer forwarding rules connected to this service attachment. Structure is documented below.

  • self_link - The URI of the created resource.

The `connected_endpoints` block contains:
  • endpoint - The URL of the consumer forwarding rule.

  • status - The status of the connection from the consumer forwarding rule to this service attachment.

Explanation in Terraform Registry

Represents a ServiceAttachment resource. To get more information about ServiceAttachment, 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.



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.



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.



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.



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.



Ensure to use modern TLS protocols

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



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 Service Attachment?

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


Automate config file reviews on your commits

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