This product is not supported for your selected Datadog site. ().
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

gcp_compute_instance_template

ancestors

Type: UNORDERED_LIST_STRING

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] The creation timestamp for this instance template in RFC3339 text format.

description

Type: STRING
Provider name: description
Description: An optional description of this resource. Provide this property when you create the resource.

id

Type: STRING
Provider name: id
Description: [Output Only] A unique identifier for this instance template. The server defines this identifier.

kind

Type: STRING
Provider name: kind
Description: [Output Only] The resource type, which is always compute#instanceTemplate for instance templates.

labels

Type: UNORDERED_LIST_STRING

name

Type: STRING
Provider name: name
Description: 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.

organization_id

Type: STRING

parent

Type: STRING

project_id

Type: STRING

project_number

Type: STRING

properties

Type: STRUCT
Provider name: properties
Description: The instance properties for this instance template.

  • advanced_machine_features
    Type: STRUCT
    Provider name: advancedMachineFeatures
    Description: Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet.
    • enable_nested_virtualization
      Type: BOOLEAN
      Provider name: enableNestedVirtualization
      Description: Whether to enable nested virtualization or not (default is false).
    • enable_uefi_networking
      Type: BOOLEAN
      Provider name: enableUefiNetworking
      Description: Whether to enable UEFI networking for instance creation.
    • performance_monitoring_unit
      Type: STRING
      Provider name: performanceMonitoringUnit
      Description: Type of Performance Monitoring Unit requested on instance.
      Possible values:
      • ARCHITECTURAL - Architecturally defined non-LLC events.
      • ENHANCED - Most documented core/L2 and LLC events.
      • PERFORMANCE_MONITORING_UNIT_UNSPECIFIED
      • STANDARD - Most documented core/L2 events.
    • threads_per_core
      Type: INT32
      Provider name: threadsPerCore
      Description: The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
    • turbo_mode
      Type: STRING
      Provider name: turboMode
      Description: Turbo frequency mode to use for the instance. Supported modes include: * ALL_CORE_MAX Using empty string or not setting this field will use the platform-specific default turbo mode.
    • visible_core_count
      Type: INT32
      Provider name: visibleCoreCount
      Description: The number of physical cores to expose to an instance. Multiply by the number of threads per core to compute the total number of virtual CPUs to expose to the instance. If unset, the number of cores is inferred from the instance’s nominal CPU count and the underlying platform’s SMT width.
  • can_ip_forward
    Type: BOOLEAN
    Provider name: canIpForward
    Description: Enables instances created based on these properties 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.
  • confidential_instance_config
    Type: STRUCT
    Provider name: confidentialInstanceConfig
    Description: Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet.
    • confidential_instance_type
      Type: STRING
      Provider name: confidentialInstanceType
      Description: Defines the type of technology used by the confidential instance.
      Possible values:
      • CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED - No type specified. Do not use this value.
      • SEV - AMD Secure Encrypted Virtualization.
      • SEV_SNP - AMD Secure Encrypted Virtualization - Secure Nested Paging.
      • TDX - Intel Trust Domain eXtension.
    • enable_confidential_compute
      Type: BOOLEAN
      Provider name: enableConfidentialCompute
      Description: Defines whether the instance should have confidential compute enabled.
  • description
    Type: STRING
    Provider name: description
    Description: An optional text description for the instances that are created from these properties.
  • disks
    Type: UNORDERED_LIST_STRUCT
    Provider name: disks
    Description: An array of disks that are associated with the instances that are created from these properties.
    • architecture
      Type: STRING
      Provider name: architecture
      Description: [Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.
      Possible values:
      • ARCHITECTURE_UNSPECIFIED - Default value indicating Architecture is not set.
      • ARM64 - Machines with architecture ARM64
      • X86_64 - Machines with architecture X86_64
    • auto_delete
      Type: BOOLEAN
      Provider name: autoDelete
      Description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    • boot
      Type: BOOLEAN
      Provider name: boot
      Description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
    • device_name
      Type: STRING
      Provider name: deviceName
      Description: 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.
    • disk_encryption_key
      Type: STRUCT
      Provider name: diskEncryptionKey
      Description: 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. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method.
      • kms_key_name
        Type: STRING
        Provider name: kmsKeyName
        Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
      • kms_key_service_account
        Type: STRING
        Provider name: kmsKeyServiceAccount
        Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
      • raw_key
        Type: STRING
        Provider name: rawKey
        Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
      • rsa_encrypted_key
        Type: STRING
        Provider name: rsaEncryptedKey
        Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
      • sha256
        Type: STRING
        Provider name: sha256
        Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
    • disk_size_gb
      Type: INT64
      Provider name: diskSizeGb
      Description: The size of the disk in GB.
    • force_attach
      Type: BOOLEAN
      Provider name: forceAttach
      Description: [Input Only] Whether to force attach the regional disk even if it’s currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error.
    • gcp_source
      Type: STRING
      Provider name: source
      Description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot 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 for zonal disk, and the URL for regional disk.
    • guest_os_features
      Type: UNORDERED_LIST_STRUCT
      Provider name: guestOsFeatures
      Description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
      • type
        Type: STRING
        Provider name: type
        Description: The ID of a supported feature. To add multiple values, use commas to separate values. Set to one or more of the following values: - VIRTIO_SCSI_MULTIQUEUE - WINDOWS - MULTI_IP_SUBNET - UEFI_COMPATIBLE - GVNIC - SEV_CAPABLE - SUSPEND_RESUME_COMPATIBLE - SEV_LIVE_MIGRATABLE_V2 - SEV_SNP_CAPABLE - TDX_CAPABLE - IDPF - SNP_SVSM_CAPABLE For more information, see Enabling guest operating system features.
        Possible values:
        • FEATURE_TYPE_UNSPECIFIED
        • GVNIC
        • IDPF
        • MULTI_IP_SUBNET
        • SECURE_BOOT
        • SEV_CAPABLE
        • SEV_LIVE_MIGRATABLE
        • SEV_LIVE_MIGRATABLE_V2
        • SEV_SNP_CAPABLE
        • TDX_CAPABLE
        • UEFI_COMPATIBLE
        • VIRTIO_SCSI_MULTIQUEUE
        • WINDOWS
    • index
      Type: INT32
      Provider name: index
      Description: [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.
    • initialize_params
      Type: STRUCT
      Provider name: initializeParams
      Description: [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.
      • architecture
        Type: STRING
        Provider name: architecture
        Description: The architecture of the attached disk. Valid values are arm64 or x86_64.
        Possible values:
        • ARCHITECTURE_UNSPECIFIED - Default value indicating Architecture is not set.
        • ARM64 - Machines with architecture ARM64
        • X86_64 - Machines with architecture X86_64
      • description
        Type: STRING
        Provider name: description
        Description: An optional description. Provide this property when creating the disk.
      • disk_name
        Type: STRING
        Provider name: diskName
        Description: Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
      • disk_size_gb
        Type: INT64
        Provider name: diskSizeGb
        Description: Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
      • disk_type
        Type: STRING
        Provider name: diskType
        Description: 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 For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.
      • enable_confidential_compute
        Type: BOOLEAN
        Provider name: enableConfidentialCompute
        Description: Whether this disk is using confidential compute mode.
      • licenses
        Type: UNORDERED_LIST_STRING
        Provider name: licenses
        Description: A list of publicly visible licenses. Reserved for Google’s use.
      • on_update_action
        Type: STRING
        Provider name: onUpdateAction
        Description: Specifies which action to take on instance update with this disk. Default is to use the existing disk.
        Possible values:
        • RECREATE_DISK - Always recreate the disk.
        • RECREATE_DISK_IF_SOURCE_CHANGED - Recreate the disk if source (image, snapshot) of this disk is different from source of existing disk.
        • USE_EXISTING_DISK - Use the existing disk, this is the default behaviour.
      • provisioned_iops
        Type: INT64
        Provider name: provisionedIops
        Description: Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
      • provisioned_throughput
        Type: INT64
        Provider name: provisionedThroughput
        Description: Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.
      • replica_zones
        Type: UNORDERED_LIST_STRING
        Provider name: replicaZones
        Description: Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.
      • resource_policies
        Type: UNORDERED_LIST_STRING
        Provider name: resourcePolicies
        Description: Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
      • source_image
        Type: STRING
        Provider name: sourceImage
        Description: The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot 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-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.
      • source_image_encryption_key
        Type: STRUCT
        Provider name: sourceImageEncryptionKey
        Description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch 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.
        • kms_key_name
          Type: STRING
          Provider name: kmsKeyName
          Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
        • kms_key_service_account
          Type: STRING
          Provider name: kmsKeyServiceAccount
          Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
        • raw_key
          Type: STRING
          Provider name: rawKey
          Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
        • rsa_encrypted_key
          Type: STRING
          Provider name: rsaEncryptedKey
          Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        • sha256
          Type: STRING
          Provider name: sha256
          Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      • source_snapshot
        Type: STRING
        Provider name: sourceSnapshot
        Description: The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. 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. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image instead when you create VMs using the bulk insert method.
      • source_snapshot_encryption_key
        Type: STRUCT
        Provider name: sourceSnapshotEncryptionKey
        Description: The customer-supplied encryption key of the source snapshot.
        • kms_key_name
          Type: STRING
          Provider name: kmsKeyName
          Description: The name of the encryption key that is stored in Google Cloud KMS. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key The fully-qualifed key name may be returned for resource GET requests. For example: “kmsKeyName”: “projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeyVersions/1
        • kms_key_service_account
          Type: STRING
          Provider name: kmsKeyServiceAccount
          Description: The service account being used for the encryption request for the given KMS key. If absent, the Compute Engine default service account is used. For example: “kmsKeyServiceAccount”: “name@project_id.iam.gserviceaccount.com/
        • raw_key
          Type: STRING
          Provider name: rawKey
          Description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rawKey”: “SGVsbG8gZnJvbSBHb29nbGUgQ2xvdWQgUGxhdGZvcm0="
        • rsa_encrypted_key
          Type: STRING
          Provider name: rsaEncryptedKey
          Description: Specifies an RFC 4648 base64 encoded, RSA-wrapped 2048-bit customer-supplied encryption key to either encrypt or decrypt this resource. You can provide either the rawKey or the rsaEncryptedKey. For example: “rsaEncryptedKey”: “ieCx/NcW06PcT7Ep1X6LUTc/hLvUDYyzSZPPVCVPTVEohpeHASqC8uw5TzyO9U+Fka9JFH z0mBibXUInrC/jEk014kCK/NPjYgEMOyssZ4ZINPKxlUh2zn1bV+MCaTICrdmuSBTWlUUiFoD D6PYznLwh8ZNdaheCeZ8ewEXgFQ8V+sDroLaN3Xs3MDTXQEMMoNUXMCZEIpg9Vtp9x2oe==” The key must meet the following requirements before you can provide it to Compute Engine: 1. The key is wrapped using a RSA public key certificate provided by Google. 2. After being wrapped, the key must be encoded in RFC 4648 base64 encoding. Gets the RSA public key certificate provided by Google at: https://cloud-certs.storage.googleapis.com/google-cloud-csek-ingress.pem
        • sha256
          Type: STRING
          Provider name: sha256
          Description: [Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.
      • storage_pool
        Type: STRING
        Provider name: storagePool
        Description: The storage pool in which the new disk is created. 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 /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool
    • interface
      Type: STRING
      Provider name: interface
      Description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks.
      Possible values:
      • NVME
      • SCSI
    • kind
      Type: STRING
      Provider name: kind
      Description: [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
    • licenses
      Type: UNORDERED_LIST_STRING
      Provider name: licenses
      Description: [Output Only] Any valid publicly visible licenses.
    • mode
      Type: STRING
      Provider name: mode
      Description: 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.
      Possible values:
      • READ_ONLY - Attaches this disk in read-only mode. Multiple virtual machines can use a disk in read-only mode at a time.
      • READ_WRITE - [Default] Attaches this disk in read-write mode. Only one virtual machine at a time can be attached to a disk in read-write mode.
    • saved_state
      Type: STRING
      Provider name: savedState
      Description: For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.
      Possible values:
      • DISK_SAVED_STATE_UNSPECIFIED - [Default] Disk state has not been preserved.
      • PRESERVED - Disk state has been preserved.
    • shielded_instance_initial_state
      Type: STRUCT
      Provider name: shieldedInstanceInitialState
      Description: [Output Only] shielded vm initial state stored on disk
      • dbs
        Type: UNORDERED_LIST_STRUCT
        Provider name: dbs
        Description: The Key Database (db).
        • file_type
          Type: STRING
          Provider name: fileType
          Description: The file type of source file.
          Possible values:
          • BIN
          • UNDEFINED
          • X509
      • dbxs
        Type: UNORDERED_LIST_STRUCT
        Provider name: dbxs
        Description: The forbidden key database (dbx).
        • file_type
          Type: STRING
          Provider name: fileType
          Description: The file type of source file.
          Possible values:
          • BIN
          • UNDEFINED
          • X509
      • keks
        Type: UNORDERED_LIST_STRUCT
        Provider name: keks
        Description: The Key Exchange Key (KEK).
        • file_type
          Type: STRING
          Provider name: fileType
          Description: The file type of source file.
          Possible values:
          • BIN
          • UNDEFINED
          • X509
      • pk
        Type: STRUCT
        Provider name: pk
        Description: The Platform Key (PK).
        • file_type
          Type: STRING
          Provider name: fileType
          Description: The file type of source file.
          Possible values:
          • BIN
          • UNDEFINED
          • X509
    • type
      Type: STRING
      Provider name: type
      Description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
      Possible values:
      • PERSISTENT
      • SCRATCH
  • guest_accelerators
    Type: UNORDERED_LIST_STRUCT
    Provider name: guestAccelerators
    Description: A list of guest accelerator cards’ type and count to use for instances created from these properties.
    • accelerator_count
      Type: INT32
      Provider name: acceleratorCount
      Description: The number of the guest accelerator cards exposed to this instance.
    • accelerator_type
      Type: STRING
      Provider name: acceleratorType
      Description: 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.
  • key_revocation_action_type
    Type: STRING
    Provider name: keyRevocationActionType
    Description: KeyRevocationActionType of the instance. Supported options are “STOP” and “NONE”. The default value is “NONE” if it is not specified.
    Possible values:
    • KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED - Default value. This value is unused.
    • NONE - Indicates user chose no operation.
    • STOP - Indicates user chose to opt for VM shutdown on key revocation.
  • machine_type
    Type: STRING
    Provider name: machineType
    Description: The machine type to use for instances that are created from these properties. This field only accepts a machine type name, for example n2-standard-4. If you use the machine type full or partial URL, for example projects/my-l7ilb-project/zones/us-central1-a/machineTypes/n2-standard-4, the request will result in an INTERNAL_ERROR.
  • metadata
    Type: STRUCT
    Provider name: metadata
    Description: The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information.
    • items
      Type: UNORDERED_LIST_STRUCT
      Provider name: items
      Description: Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
      • key
        Type: STRING
        Provider name: key
        Description: 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.
      • value
        Type: STRING
        Provider name: value
        Description: 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).
    • kind
      Type: STRING
      Provider name: kind
      Description: [Output Only] Type of the resource. Always compute#metadata for metadata.
  • min_cpu_platform
    Type: STRING
    Provider name: minCpuPlatform
    Description: Minimum cpu/platform to be used by instances. 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.
  • network_interfaces
    Type: UNORDERED_LIST_STRUCT
    Provider name: networkInterfaces
    Description: An array of network access configurations for this interface.
    • access_configs
      Type: UNORDERED_LIST_STRUCT
      Provider name: accessConfigs
      Description: 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.
      • external_ipv6
        Type: STRING
        Provider name: externalIpv6
        Description: Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance’s zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance’s subnetwork.
      • external_ipv6_prefix_length
        Type: INT32
        Provider name: externalIpv6PrefixLength
        Description: Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.
      • kind
        Type: STRING
        Provider name: kind
        Description: [Output Only] Type of the resource. Always compute#accessConfig for access configs.
      • name
        Type: STRING
        Provider name: name
        Description: The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
      • nat_ip
        Type: STRING
        Provider name: natIP
        Description: Applies to accessConfigs (IPv4) only. 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.
      • network_tier
        Type: STRING
        Provider name: networkTier
        Description: This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
        Possible values:
        • FIXED_STANDARD - Public internet quality with fixed bandwidth.
        • PREMIUM - High quality, Google-grade network tier, support for all networking products.
        • STANDARD - Public internet quality, only limited support for other networking products.
        • STANDARD_OVERRIDES_FIXED_STANDARD - (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
      • public_ptr_domain_name
        Type: STRING
        Provider name: publicPtrDomainName
        Description: The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range.
      • security_policy
        Type: STRING
        Provider name: securityPolicy
        Description: The resource URL for the security policy associated with this access config.
      • set_public_ptr
        Type: BOOLEAN
        Provider name: setPublicPtr
        Description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
      • type
        Type: STRING
        Provider name: type
        Description: The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
        Possible values:
        • DIRECT_IPV6
        • ONE_TO_ONE_NAT
    • alias_ip_ranges
      Type: UNORDERED_LIST_STRUCT
      Provider name: aliasIpRanges
      Description: An array of alias IP ranges for this network interface. You can only specify this field for network interfaces in VPC networks.
      • ip_cidr_range
        Type: STRING
        Provider name: ipCidrRange
        Description: The IP alias ranges to allocate for this interface. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (such as 10.2.3.4), a netmask (such as /24) or a CIDR-formatted string (such as 10.1.2.0/24).
      • subnetwork_range_name
        Type: STRING
        Provider name: subnetworkRangeName
        Description: The name of a subnetwork secondary IP range from which to allocate an IP alias range. If not specified, the primary range of the subnetwork is used.
    • internal_ipv6_prefix_length
      Type: INT32
      Provider name: internalIpv6PrefixLength
      Description: The prefix length of the primary internal IPv6 range.
    • ipv6_access_configs
      Type: UNORDERED_LIST_STRUCT
      Provider name: ipv6AccessConfigs
      Description: An array of IPv6 access configurations for this interface. Currently, only one IPv6 access config, DIRECT_IPV6, is supported. If there is no ipv6AccessConfig specified, then this instance will have no external IPv6 Internet access.
      • external_ipv6
        Type: STRING
        Provider name: externalIpv6
        Description: Applies to ipv6AccessConfigs only. The first IPv6 address of the external IPv6 range associated with this instance, prefix length is stored in externalIpv6PrefixLength in ipv6AccessConfig. To use a static external IP address, it must be unused and in the same region as the instance’s zone. If not specified, Google Cloud will automatically assign an external IPv6 address from the instance’s subnetwork.
      • external_ipv6_prefix_length
        Type: INT32
        Provider name: externalIpv6PrefixLength
        Description: Applies to ipv6AccessConfigs only. The prefix length of the external IPv6 range.
      • kind
        Type: STRING
        Provider name: kind
        Description: [Output Only] Type of the resource. Always compute#accessConfig for access configs.
      • name
        Type: STRING
        Provider name: name
        Description: The name of this access configuration. In accessConfigs (IPv4), the default and recommended name is External NAT, but you can use any arbitrary string, such as My external IP or Network Access. In ipv6AccessConfigs, the recommend name is External IPv6.
      • nat_ip
        Type: STRING
        Provider name: natIP
        Description: Applies to accessConfigs (IPv4) only. 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.
      • network_tier
        Type: STRING
        Provider name: networkTier
        Description: This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD. If an AccessConfig is specified without a valid external IP address, an ephemeral IP will be created with this networkTier. If an AccessConfig with a valid external IP address is specified, it must match that of the networkTier associated with the Address resource owning that IP.
        Possible values:
        • FIXED_STANDARD - Public internet quality with fixed bandwidth.
        • PREMIUM - High quality, Google-grade network tier, support for all networking products.
        • STANDARD - Public internet quality, only limited support for other networking products.
        • STANDARD_OVERRIDES_FIXED_STANDARD - (Output only) Temporary tier for FIXED_STANDARD when fixed standard tier is expired or not configured.
      • public_ptr_domain_name
        Type: STRING
        Provider name: publicPtrDomainName
        Description: The DNS domain name for the public PTR record. You can set this field only if the setPublicPtr field is enabled in accessConfig. If this field is unspecified in ipv6AccessConfig, a default PTR record will be created for first IP in associated external IPv6 range.
      • security_policy
        Type: STRING
        Provider name: securityPolicy
        Description: The resource URL for the security policy associated with this access config.
      • set_public_ptr
        Type: BOOLEAN
        Provider name: setPublicPtr
        Description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. This field is not used in ipv6AccessConfig. A default PTR record will be created if the VM has external IPv6 range associated.
      • type
        Type: STRING
        Provider name: type
        Description: The type of configuration. In accessConfigs (IPv4), the default and only option is ONE_TO_ONE_NAT. In ipv6AccessConfigs, the default and only option is DIRECT_IPV6.
        Possible values:
        • DIRECT_IPV6
        • ONE_TO_ONE_NAT
    • ipv6_access_type
      Type: STRING
      Provider name: ipv6AccessType
      Description: [Output Only] One of EXTERNAL, INTERNAL to indicate whether the IP can be accessed from the Internet. This field is always inherited from its subnetwork. Valid only if stackType is IPV4_IPV6.
      Possible values:
      • EXTERNAL - This network interface can have external IPv6.
      • INTERNAL - This network interface can have internal IPv6.
    • ipv6_address
      Type: STRING
      Provider name: ipv6Address
      Description: An IPv6 internal network address for this network interface. To use a static internal IP address, it must be unused and in the same region as the instance’s zone. If not specified, Google Cloud will automatically assign an internal IPv6 address from the instance’s subnetwork.
    • kind
      Type: STRING
      Provider name: kind
      Description: [Output Only] Type of the resource. Always compute#networkInterface for network interfaces.
    • name
      Type: STRING
      Provider name: name
      Description: [Output Only] The name of the network interface, which is generated by the server. For a VM, the network interface uses the nicN naming format. Where N is a value between 0 and 7. The default interface value is nic0.
    • network
      Type: STRING
      Provider name: network
      Description: URL of the VPC 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 selected project doesn’t have the default network, you must specify a network or subnet. 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
    • network_attachment
      Type: STRING
      Provider name: networkAttachment
      Description: The URL of the network attachment that this interface should connect to in the following format: projects/{project_number}/regions/{region_name}/networkAttachments/{network_attachment_name}.
    • network_ip
      Type: STRING
      Provider name: networkIP
      Description: 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.
    • nic_type
      Type: STRING
      Provider name: nicType
      Description: The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.
      Possible values:
      • GVNIC - GVNIC
      • IDPF - IDPF
      • IRDMA - IRDMA
      • MRDMA - MRDMA
      • UNSPECIFIED_NIC_TYPE - No type specified.
      • VIRTIO_NET - VIRTIO
    • queue_count
      Type: INT32
      Provider name: queueCount
      Description: The networking queue count that’s specified by users for the network interface. Both Rx and Tx queues will be set to this number. It’ll be empty if not specified by the users.
    • stack_type
      Type: STRING
      Provider name: stackType
      Description: The stack type for this network interface. To assign only IPv4 addresses, use IPV4_ONLY. To assign both IPv4 and IPv6 addresses, use IPV4_IPV6. If not specified, IPV4_ONLY is used. This field can be both set at instance creation and update network interface operations.
      Possible values:
      • IPV4_IPV6 - The network interface can have both IPv4 and IPv6 addresses.
      • IPV4_ONLY - The network interface will only be assigned IPv4 addresses.
      • IPV6_ONLY - The network interface will only be assigned IPv6 addresses.
    • subnetwork
      Type: STRING
      Provider name: subnetwork
      Description: 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
  • network_performance_config
    Type: STRUCT
    Provider name: networkPerformanceConfig
    Description: Note that for MachineImage, this is not supported yet.
    • total_egress_bandwidth_tier
      Type: STRING
      Provider name: totalEgressBandwidthTier
  • private_ipv6_google_access
    Type: STRING
    Provider name: privateIpv6GoogleAccess
    Description: The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.
    Possible values:
    • ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE - Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.
    • ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE - Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance’s default network interface will be assigned an internal IPv6 prefix if it doesn’t have before.
    • INHERIT_FROM_SUBNETWORK - Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.
  • reservation_affinity
    Type: STRUCT
    Provider name: reservationAffinity
    Description: Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet.
    • consume_reservation_type
      Type: STRING
      Provider name: consumeReservationType
      Description: 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.
      Possible values:
      • ANY_RESERVATION - Consume any allocation available.
      • NO_RESERVATION - Do not consume from any allocated capacity.
      • SPECIFIC_RESERVATION - Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
      • UNSPECIFIED
    • key
      Type: STRING
      Provider name: key
      Description: 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.
    • values
      Type: UNORDERED_LIST_STRING
      Provider name: values
      Description: Corresponds to the label values of a reservation resource. This can be either a name to a reservation in the same project or “projects/different-project/reservations/some-reservation-name” to target a shared reservation in the same zone but in a different project.
  • resource_policies
    Type: UNORDERED_LIST_STRING
    Provider name: resourcePolicies
    Description: Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
  • scheduling
    Type: STRUCT
    Provider name: scheduling
    Description: Specifies the scheduling options for the instances that are created from these properties.
    • automatic_restart
      Type: BOOLEAN
      Provider name: automaticRestart
      Description: 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.
    • availability_domain
      Type: INT32
      Provider name: availabilityDomain
      Description: Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.
    • host_error_timeout_seconds
      Type: INT32
      Provider name: hostErrorTimeoutSeconds
      Description: Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.
    • instance_termination_action
      Type: STRING
      Provider name: instanceTerminationAction
      Description: Specifies the termination action for the instance.
      Possible values:
      • DELETE - Delete the VM.
      • INSTANCE_TERMINATION_ACTION_UNSPECIFIED - Default value. This value is unused.
      • STOP - Stop the VM without storing in-memory content. default action.
    • local_ssd_recovery_timeout
      Type: STRUCT
      Provider name: localSsdRecoveryTimeout
      Description: Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.
      • nanos
        Type: INT32
        Provider name: nanos
        Description: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
      • seconds
        Type: INT64
        Provider name: seconds
        Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
    • location_hint
      Type: STRING
      Provider name: locationHint
      Description: An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API.
    • max_run_duration
      Type: STRUCT
      Provider name: maxRunDuration
      Description: Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.
      • nanos
        Type: INT32
        Provider name: nanos
        Description: Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.
      • seconds
        Type: INT64
        Provider name: seconds
        Description: Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
    • min_node_cpus
      Type: INT32
      Provider name: minNodeCpus
      Description: The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
    • node_affinities
      Type: UNORDERED_LIST_STRUCT
      Provider name: nodeAffinities
      Description: A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.
      • key
        Type: STRING
        Provider name: key
        Description: Corresponds to the label key of Node resource.
      • operator
        Type: STRING
        Provider name: operator
        Description: Defines the operation of node selection. Valid operators are IN for affinity and NOT_IN for anti-affinity.
        Possible values:
        • IN - Requires Compute Engine to seek for matched nodes.
        • NOT_IN - Requires Compute Engine to avoid certain nodes.
        • OPERATOR_UNSPECIFIED
      • values
        Type: UNORDERED_LIST_STRING
        Provider name: values
        Description: Corresponds to the label values of Node resource.
    • on_host_maintenance
      Type: STRING
      Provider name: onHostMaintenance
      Description: 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 Set VM host maintenance policy.
      Possible values:
      • MIGRATE - [Default] Allows Compute Engine to automatically migrate instances out of the way of maintenance events.
      • TERMINATE - Tells Compute Engine to terminate and (optionally) restart the instance away from the maintenance activity. If you would like your instance to be restarted, set the automaticRestart flag to true. Your instance may be restarted more than once, and it may be restarted outside the window of maintenance events.
    • on_instance_stop_action
      Type: STRUCT
      Provider name: onInstanceStopAction
      • discard_local_ssd
        Type: BOOLEAN
        Provider name: discardLocalSsd
        Description: If true, the contents of any attached Local SSD disks will be discarded else, the Local SSD data will be preserved when the instance is stopped at the end of the run duration/termination time.
    • preemptible
      Type: BOOLEAN
      Provider name: preemptible
      Description: Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states.
    • provisioning_model
      Type: STRING
      Provider name: provisioningModel
      Description: Specifies the provisioning model of the instance.
      Possible values:
      • RESERVATION_BOUND - Bound to the lifecycle of the reservation in which it is provisioned.
      • SPOT - Heavily discounted, no guaranteed runtime.
      • STANDARD - Standard provisioning with user controlled runtime, no discounts.
    • termination_time
      Type: STRING
      Provider name: terminationTime
      Description: Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time.
  • service_accounts
    Type: UNORDERED_LIST_STRUCT
    Provider name: serviceAccounts
    Description: A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
    • email
      Type: STRING
      Provider name: email
      Description: Email address of the service account.
    • scopes
      Type: UNORDERED_LIST_STRING
      Provider name: scopes
      Description: The list of scopes to be made available for this service account.
  • shielded_instance_config
    Type: STRUCT
    Provider name: shieldedInstanceConfig
    Description: Note that for MachineImage, this is not supported yet.
    • enable_integrity_monitoring
      Type: BOOLEAN
      Provider name: enableIntegrityMonitoring
      Description: Defines whether the instance has integrity monitoring enabled. Enabled by default.
    • enable_secure_boot
      Type: BOOLEAN
      Provider name: enableSecureBoot
      Description: Defines whether the instance has Secure Boot enabled. Disabled by default.
    • enable_vtpm
      Type: BOOLEAN
      Provider name: enableVtpm
      Description: Defines whether the instance has the vTPM enabled. Enabled by default.

region

Type: STRING
Provider name: region
Description: [Output Only] URL of the region where the instance template resides. Only applicable for regional resources.

resource_name

Type: STRING

Type: STRING
Provider name: selfLink
Description: [Output Only] The URL for this instance template. The server defines this URL.

source_instance

Type: STRING
Provider name: sourceInstance
Description: 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

source_instance_params

Type: STRUCT
Provider name: sourceInstanceParams
Description: The source instance params to use to create this instance template.

  • disk_configs
    Type: UNORDERED_LIST_STRUCT
    Provider name: diskConfigs
    Description: Attached disks configuration. If not provided, defaults are applied: For boot disk and any other R/W disks, the source images for each disk will be used. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
    • auto_delete
      Type: BOOLEAN
      Provider name: autoDelete
      Description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
    • custom_image
      Type: STRING
      Provider name: customImage
      Description: The custom source image to be used to restore this disk when instantiating this instance template.
    • device_name
      Type: STRING
      Provider name: deviceName
      Description: Specifies the device name of the disk to which the configurations apply to.
    • instantiate_from
      Type: STRING
      Provider name: instantiateFrom
      Description: 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.
      Possible values:
      • ATTACH_READ_ONLY - Attach the existing disk in read-only mode. The request will fail if the disk was attached in read-write mode on the source instance. Applicable to: read-only disks.
      • BLANK - Create a blank disk. The disk will be created unformatted. Applicable to: additional read-write disks, local SSDs.
      • CUSTOM_IMAGE - Use the custom image specified in the custom_image field. Applicable to: boot disk, additional read-write disks.
      • DEFAULT - Use the default instantiation option for the corresponding type of disk. For boot disk and any other R/W disks, new custom images will be created from each disk. For read-only disks, they will be attached in read-only mode. Local SSD disks will be created as blank volumes.
      • DO_NOT_INCLUDE - Do not include the disk in the instance template. Applicable to: additional read-write disks, local SSDs, read-only disks.
      • SOURCE_IMAGE - Use the same source image used for creation of the source instance’s corresponding disk. The request will fail if the source VM’s disk was created from a snapshot. Applicable to: boot disk, additional read-write disks.
      • SOURCE_IMAGE_FAMILY - Use the same source image family used for creation of the source instance’s corresponding disk. The request will fail if the source image of the source disk does not belong to any image family. Applicable to: boot disk, additional read-write disks.

tags

Type: UNORDERED_LIST_STRING