Insert

Creates an instance template in the specified project using the data that is included in the request

88 variables
32 variables

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

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

  • View and manage your data across Google Cloud Platform services
  • View and manage your Google Compute Engine resources

Input

This building block consumes 88 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

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 INTEGER

[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 OBJECT

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 documentation for more information

properties.description STRING

An optional text description for the instances that are created from this instance template

properties.disks[] OBJECT

An instance-attached disk resource

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-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks

properties.disks[].diskEncryptionKey OBJECT

Represents a customer-supplied encryption key

properties.disks[].diskEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

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[].guestOsFeatures[] OBJECT

Guest OS features

properties.disks[].index INTEGER

[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number

properties.disks[].initializeParams 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.description STRING

An optional description. Provide this property when creating the disk

properties.disks[].initializeParams.diskName STRING

Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated

properties.disks[].initializeParams.diskSizeGb INTEGER

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.labels OBJECT

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

properties.disks[].initializeParams.labels.customKey.value STRING Required

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks

properties.disks[].initializeParams.resourcePolicies[] STRING

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 except for local SSD.

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

Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD

To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image

You can also specify a custom 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-image-family

If the source image is deleted later, this field will not be set

properties.disks[].initializeParams.sourceSnapshot STRING

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or disks.source is required except for local SSD.

To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup

If the source snapshot is deleted later, this field will not be set

properties.disks[].interface ENUMERATION

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. TODO(b/131765817): Update documentation when NVME is supported

properties.disks[].kind STRING

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks

properties.disks[].licenses[] STRING

properties.disks[].mode ENUMERATION

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 except for local SSD.

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 ENUMERATION

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT

properties.guestAccelerators[] OBJECT

A specification of the type and number of accelerator cards attached to the instance

properties.guestAccelerators[].acceleratorCount INTEGER

The number of the guest accelerator cards exposed to this instance

properties.guestAccelerators[].acceleratorType STRING

Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types

properties.labels OBJECT

Labels to apply to instances that are created from this template

properties.labels.customKey.value STRING Required

Labels to apply to instances that are created from this template

properties.machineType STRING

The machine type to use for instances that are created from this template

properties.metadata OBJECT

A metadata key/value entry

properties.metadata.fingerprint BINARY

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, otherwise the request will fail with error 412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve the resource

properties.metadata.items[] OBJECT

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 262144 bytes (256 KiB)

properties.metadata.kind STRING

[Output Only] Type of the resource. Always compute#metadata for metadata

properties.minCpuPlatform STRING

Minimum cpu/platform to be used by this instance. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform

properties.networkInterfaces[] OBJECT

A network interface resource attached to an instance

properties.networkInterfaces[].accessConfigs[] OBJECT

An access configuration attached to an instance's network interface. Only one access config per instance is supported

properties.networkInterfaces[].aliasIpRanges[] OBJECT

An alias IP range attached to an instance's network interface

properties.networkInterfaces[].fingerprint BINARY

Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet

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, which is 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.

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 IP 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 specify this field. If the network is in auto subnet mode, specifying the subnetwork is optional. If the network is in custom subnet mode, specifying the subnetwork is required. If you specify this field, 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.reservationAffinity OBJECT

Specifies the reservations that this instance can consume from

properties.reservationAffinity.consumeReservationType ENUMERATION

Specifies the type of reservation from which this instance can consume resources: ANY_RESERVATION (default), SPECIFIC_RESERVATION, or NO_RESERVATION. See Consuming reserved instances for examples

properties.reservationAffinity.key STRING

Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify googleapis.com/reservation-name as the key and specify the name of your reservation as its value

properties.reservationAffinity.values[] STRING

properties.scheduling OBJECT

Sets the scheduling options for an Instance. NextID: 9

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.

By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine

properties.scheduling.nodeAffinities[] OBJECT

Node Affinity: the configuration of desired nodes onto which this Instance could be scheduled

properties.scheduling.nodeAffinities[].key STRING

Corresponds to the label key of Node resource

properties.scheduling.nodeAffinities[].operator ENUMERATION

Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity

properties.scheduling.nodeAffinities[].values[] STRING

properties.scheduling.onHostMaintenance ENUMERATION

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

Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created

properties.serviceAccounts[] OBJECT

A service account

properties.serviceAccounts[].email STRING

Email address of the service account

properties.serviceAccounts[].scopes[] STRING

properties.shieldedInstanceConfig OBJECT

A set of Shielded Instance options

properties.shieldedInstanceConfig.enableIntegrityMonitoring BOOLEAN

Defines whether the instance has integrity monitoring enabled

properties.shieldedInstanceConfig.enableSecureBoot BOOLEAN

Defines whether the instance has Secure Boot enabled

properties.shieldedInstanceConfig.enableVtpm BOOLEAN

Defines whether the instance has the vTPM enabled

properties.tags OBJECT

A set of instance tags

properties.tags.fingerprint BINARY

Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags.

To see the latest fingerprint, make get() request to the instance

properties.tags.items[] STRING

selfLink STRING

[Output Only] The URL for this instance template. The server defines this URL

sourceInstance STRING

The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values:

  • https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance
  • projects/project/zones/zone/instances/instance

sourceInstanceParams OBJECT

A specification of the parameters to use when creating the instance template from a source instance

sourceInstanceParams.diskConfigs[] OBJECT

A specification of the desired way to instantiate a disk in the instance template when its created from a source instance

sourceInstanceParams.diskConfigs[].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)

sourceInstanceParams.diskConfigs[].customImage STRING

The custom source image to be used to restore this disk when instantiating this instance template

sourceInstanceParams.diskConfigs[].deviceName STRING

Specifies the device name of the disk to which the configurations apply to

sourceInstanceParams.diskConfigs[].instantiateFrom ENUMERATION

Specifies whether to include the disk and what image to use. Possible values are:

  • source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
  • source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks.
  • custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks.
  • attach-read-only: to attach a read-only disk. Applicable to read-only disks.
  • do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.

Output

This building block provides 32 output parameters

  = Parameter name
  = Format

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

warnings[].code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warnings[].data[] OBJECT

warnings[].data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warnings[].data[].value STRING

[Output Only] A warning data value corresponding to the key

warnings[].message STRING

[Output Only] A human-readable description of the warning code

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations