Google Compute Engine Machine Image

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

google_compute_machine_image (Terraform)

The Machine Image in Compute Engine can be configured in Terraform with the resource name google_compute_machine_image. The following sections describe 2 examples of how to use the resource and its parameters.

Example Usage from GitHub
resource "google_compute_machine_image" "image" {
  provider        = "google-beta"
  name            = "image"
  source_instance = google_compute_instance.vm.self_link
resource "google_compute_machine_image" "image" {
  provider        = "google-beta"
  name            = "image"
  source_instance = google_compute_instance.vm.self_link

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.

  • source_instance - (Required) The source instance used to create the machine image. You can provide this as a partial or full URL to the resource.

  • description - (Optional) A text description of the resource.

  • guest_flush - (Optional) Specify this to create an application consistent machine image by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS).

  • machine_image_encryption_key - (Optional) Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image with a customer-supplied key, you must provide the same key if you use the machine image later (e.g. to create a instance from the image) Structure is documented below.

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

The machine_image_encryption_key block supports:

  • raw_key - (Optional) Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

  • sha256 - The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.

  • kms_key_name - (Optional) The name of the encryption key that is stored in Google Cloud KMS.

  • kms_key_service_account - (Optional) The service account used for the encryption request for the given KMS key. If absent, the Compute Engine Service Agent service account is used.

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

  • id - an identifier for the resource with format projects/[[project]]/global/machineImages/[[name]]

  • storage_locations - The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

  • self_link - The URI of the created resource.

Explanation in Terraform Registry

Represents a Machine Image resource. Machine images store all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance.

Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources. To get more information about MachineImage, 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 Machine Image?

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

For Terraform, the gilyas/infracost and infracost/infracost source code examples are useful. See the Terraform Example section for further details.


Automate config file reviews on your commits

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