Creates an Instance in Google Compute Engine based on specified parameters from existing Template.

View on GitHub

Last Updated: Feb. 25, 2023

Access Instructions

Install the Google provider package into your Airflow environment.

Import the module into your DAG file and instantiate it with your desired params.


bodyRequiredInstance representation as object. For this Operator only ‘name’ parameter is required for creating new Instance since all other parameters will be passed through the Template.
source_instance_templateRequiredExisting Instance Template that will be used as a base while creating new Instance. When specified, only name of new Instance should be provided as input arguments in ‘body’ parameter when creating new Instance. All other parameters, such as ‘machine_type’, ‘disks’ and ‘network_interfaces’ will be passed to Instance as they are specified in the Instance Template. Full or partial URL and can be represented as examples below: 1. “” 2. “projects/your-project-name/global/instanceTemplates/temp” 3. “global/instanceTemplates/temp”
zoneRequiredGoogle Cloud zone where the instance exists.
project_idGoogle Cloud project ID where the Compute Engine Instance exists. If set to None or missing, the default project_id from the Google Cloud connection is used.
resource_idName of the Instance. If the name of Instance is not specified in body[‘name’], the name will be taken from ‘resource_id’ parameter
request_idUnique request_id that you might add to achieve full idempotence (for example when client call times out repeating the request with the same request id will not create a new instance template again) It should be in UUID format as defined in RFC 4122
gcp_conn_idThe connection ID used to connect to Google Cloud. Defaults to ‘google_cloud_default’.
api_versionAPI version used (for example v1 - or beta). Defaults to v1.
impersonation_chainService account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account (templated).
retryA retry object used to retry requests. If None is specified, requests will not be retried.
timeoutThe amount of time, in seconds, to wait for the request to complete. Note that if retry is specified, the timeout applies to each individual attempt.
metadataAdditional metadata that is provided to the method.


Creates an Instance in Google Compute Engine based on specified parameters from existing Template.

See also

For more information on how to use this operator, take a look at the guide: ComputeEngineInsertInstanceFromTemplateOperator

Was this page helpful?