InstanceTemplates

Defines an Instance Template resource that provides configuration settings for your virtual machine instances. Instance templates are not tied to the lifetime of an instance and can be used and reused as to deploy virtual machines. You can also use different templates to create different virtual machine configurations. Instance templates are required when you create a managed instance group.

For a list of methods for this resource, see the end of this page.

Resource representations

An Instance Template resource.

{
  "kind": "compute#instanceTemplate",
  "id": unsigned long,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "properties": {
    "description": string,
    "tags": {
      "items": [
        string
      ],
      "fingerprint": bytes
    },
    "machineType": string,
    "canIpForward": boolean,
    "networkInterfaces": [
      {
        "kind": "compute#networkInterface",
        "network": string,
        "subnetwork": string,
        "networkIP": string,
        "name": string,
        "accessConfigs": [
          {
            "kind": "compute#accessConfig",
            "type": string,
            "name": string,
            "natIP": string
          }
        ]
      }
    ],
    "disks": [
      {
        "kind": "compute#attachedDisk",
        "type": string,
        "mode": string,
        "source": string,
        "deviceName": string,
        "index": integer,
        "boot": boolean,
        "initializeParams": {
          "diskName": string,
          "sourceImage": string,
          "diskSizeGb": long,
          "diskType": string,
          "sourceImageEncryptionKey": {
            "rawKey": string,
            "sha256": string
          }
        },
        "autoDelete": boolean,
        "licenses": [
          string
        ],
        "interface": string,
        "diskEncryptionKey": {
          "rawKey": string,
          "sha256": string
        }
      }
    ],
    "metadata": {
      "kind": "compute#metadata",
      "fingerprint": bytes,
      "items": [
        {
          "key": string,
          "value": string
        }
      ]
    },
    "serviceAccounts": [
      {
        "email": string,
        "scopes": [
          string
        ]
      }
    ],
    "scheduling": {
      "onHostMaintenance": string,
      "automaticRestart": boolean,
      "preemptible": boolean
    }
  },
  "selfLink": string
}
Property name Value Description Notes
creationTimestamp string [Output Only] The creation timestamp for this instance template in RFC3339 text format.
description string An optional description of this resource. Provide this property when you create the resource.
id unsigned long [Output Only] A unique identifier for this instance template. The server defines this identifier.
kind string [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.
name string Name of the resource; provided by the client when the resource is created. 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.
properties nested object The instance properties for this instance template.
properties.canIpForward boolean Enables instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding for instances documentation for more information.
properties.description string An optional text description for the instances that are created from this instance template.
properties.disks[] list An array of disks that are associated with the instances that are created from this template.
properties.disks[].autoDelete boolean Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
properties.disks[].boot boolean Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
properties.disks[].deviceName string Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disks-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.
properties.disks[].diskEncryptionKey nested object Encrypts or decrypts a disk using a customer-supplied encryption key.

If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key.

If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance.

If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later.

Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
properties.disks[].diskEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
properties.disks[].diskEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
properties.disks[].index integer Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.
properties.disks[].initializeParams nested object [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.
properties.disks[].initializeParams.diskName string Specifies the disk name. If not specified, the default is to use the name of the instance. If provided, the instance template can only create one virtual machine instance per zone.
properties.disks[].initializeParams.diskSizeGb long Specifies the size of the disk in base-2 GB.
properties.disks[].initializeParams.diskType string Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example:

https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard

Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. For example, the following are valid values:
  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/diskType
  • projects/project/zones/zone/diskTypes/diskType
  • zones/zone/diskTypes/diskType
Note that for InstanceTemplate, this is the name of the disk type, not URL.
properties.disks[].initializeParams.sourceImage string The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-8 to use the latest Debian 8 image:

projects/debian-cloud/global/images/family/debian-8

Alternatively, use a specific version of a public operating system image:

projects/debian-cloud/global/images/debian-8-jessie-vYYYYMMDD

To create a disk with a private image that you created, specify the image name in the following format:

global/images/my-private-image

You can also specify a private image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name:

global/images/family/my-private-family

If the source image is deleted later, this field will not be set.
properties.disks[].initializeParams.sourceImageEncryptionKey nested object The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Instance templates do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
properties.disks[].initializeParams.sourceImageEncryptionKey.rawKey string Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.
properties.disks[].initializeParams.sourceImageEncryptionKey.sha256 string [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
properties.disks[].interface string Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
properties.disks[].kind string [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
properties.disks[].licenses[] list [Output Only] Any valid publicly visible licenses.
properties.disks[].mode string The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode.
properties.disks[].source string Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required.

If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks.

Note that for InstanceTemplate, specify the disk name, not the URL for the disk.
properties.disks[].type string Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
properties.machineType string Name of the machine type resource describing which machine type to use to host the instances created based on this template. Notice this differs from how the machine type is specified in the Compute Engine API, as the machine type name is required for instance templates, whereas the machine type URL is required in the API. For example, n1-standard-1.
properties.metadata nested object The metadata key/value pairs to assign to instances that are created from this template. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
properties.metadata.fingerprint bytes Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.
properties.metadata.items[] list Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
properties.metadata.items[].key string Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
properties.metadata.items[].value string Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
properties.metadata.kind string [Output Only] Type of the resource. Always compute#metadata for metadata.
properties.networkInterfaces[] list An array of network access configurations for this interface.
properties.networkInterfaces[].accessConfigs[] list An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access.
properties.networkInterfaces[].accessConfigs[].kind string [Output Only] Type of the resource. Always compute#accessConfig for access configs.
properties.networkInterfaces[].accessConfigs[].name string Name of this access configuration.
properties.networkInterfaces[].accessConfigs[].natIP string An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance.
properties.networkInterfaces[].accessConfigs[].type string The type of configuration. The default and only option is ONE_TO_ONE_NAT.

properties.networkInterfaces[].kind string [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
properties.networkInterfaces[].name string [Output Only] The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.
properties.networkInterfaces[].network string URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred.

This field is optional when creating a firewall rule. If not specified when creating a firewall rule, the default network global/networks/default is used.

If you specify this property, you can specify the network as a full or partial URL. For example, the following are all valid URLs:
  • https://www.googleapis.com/compute/v1/projects/project/global/networks/network
  • projects/project/global/networks/network
  • global/networks/default
properties.networkInterfaces[].networkIP string An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system.
properties.networkInterfaces[].subnetwork string The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
  • https://www.googleapis.com/compute/v1/projects/project/regions/region/subnetworks/subnetwork
  • regions/region/subnetworks/subnetwork
properties.scheduling nested object Specifies the scheduling options for the instances that are created from this template.
properties.scheduling.automaticRestart boolean Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted.
properties.scheduling.onHostMaintenance string Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options.
properties.scheduling.preemptible boolean Whether the instance is preemptible.
properties.serviceAccounts[] list A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from this template. Use metadata queries to obtain the access tokens for these instances.
properties.serviceAccounts[].email string Email address of the service account.
properties.serviceAccounts[].scopes[] list The list of scopes to be made available for this service account.
properties.tags nested object A list of tags to apply to the instances that are created from this template. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035.
properties.tags.fingerprint bytes Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata.

To see the latest fingerprint, make get() request to the instance.
properties.tags.items[] list An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.

Methods

delete
Deletes the specified instance template. If you delete an instance template that is being referenced from another instance group, the instance group will not be able to create or recreate virtual machine instances. Deleting an instance template is permanent and cannot be undone.
get
Returns the specified instance template. Get a list of available instance templates by making a list() request.
insert
Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template.
list
Retrieves a list of instance templates that are contained within the specified project and zone.

Send feedback about...

Compute Engine