This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

gcp_compute_instance

advanced_machine_features

Type: STRUCT
Provider name: advancedMachineFeatures
Description: Controls for advanced machine-related behavior features.

  • 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.
  • 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.
  • 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.

ancestors

Type: UNORDERED_LIST_STRING

can_ip_forward

Type: BOOLEAN
Provider name: canIpForward
Description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding .

confidential_instance_config

Type: STRUCT
Provider name: confidentialInstanceConfig

  • enable_confidential_compute
    Type: BOOLEAN
    Provider name: enableConfidentialCompute
    Description: Defines whether the instance should have confidential compute enabled.

cpu_platform

Type: STRING
Provider name: cpuPlatform
Description: [Output Only] The CPU platform used by this instance.

creation_timestamp

Type: TIMESTAMP
Provider name: creationTimestamp
Description: [Output Only] Creation timestamp in RFC3339 text format.

deletion_protection

Type: BOOLEAN
Provider name: deletionProtection
Description: Whether the resource should be protected against deletion.

description

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

display_device

Type: STRUCT
Provider name: displayDevice
Description: Enables display device for the instance.

  • enable_display
    Type: BOOLEAN
    Provider name: enableDisplay
    Description: Defines whether the instance has Display enabled.

gcp_status

Type: STRING
Provider name: status
Description: [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle.
Possible values:

  • DEPROVISIONING - The instance is halted and we are performing tear down tasks like network deprogramming, releasing quota, IP, tearing down disks etc.
  • PROVISIONING - Resources are being allocated for the instance.
  • REPAIRING - The instance is in repair.
  • RUNNING - The instance is running.
  • STAGING - All required resources have been allocated and the instance is being started.
  • STOPPED - The instance has stopped successfully.
  • STOPPING - The instance is currently stopping (either being deleted or killed).
  • SUSPENDED - The instance has suspended.
  • SUSPENDING - The instance is suspending.
  • TERMINATED - The instance has stopped (either by explicit action or underlying failure).

guest_accelerators

Type: UNORDERED_LIST_STRUCT
Provider name: guestAccelerators
Description: A list of the type and count of accelerator cards attached to the instance.

  • 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.

hostname

Type: STRING
Provider name: hostname
Description: Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS.

id

Type: STRING
Provider name: id
Description: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

instance_encryption_key

Type: STRUCT
Provider name: instanceEncryptionKey
Description: Encrypts suspended data for an instance with a customer-managed encryption key. If you are creating a new instance, this field will encrypt the local SSD and in-memory contents of the instance during the suspend operation. If you do not provide an encryption key when creating the instance, then the local SSD and in-memory contents will be encrypted using an automatically generated key during the suspend operation.

  • 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.

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.

kind

Type: STRING
Provider name: kind
Description: [Output Only] Type of the resource. Always compute#instance for instances.

labels

Type: UNORDERED_LIST_STRING

last_start_timestamp

Type: STRING
Provider name: lastStartTimestamp
Description: [Output Only] Last start timestamp in RFC3339 text format.

last_stop_timestamp

Type: STRING
Provider name: lastStopTimestamp
Description: [Output Only] Last stop timestamp in RFC3339 text format.

last_suspended_timestamp

Type: STRING
Provider name: lastSuspendedTimestamp
Description: [Output Only] Last suspended timestamp in RFC3339 text format.

machine_type

Type: STRING
Provider name: machineType
Description: Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, … 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types.

metadata

Type: STRUCT
Provider name: metadata
Description: The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys.

  • 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: Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: “Intel Haswell” or minCpuPlatform: “Intel Sandy Bridge”.

name

Type: STRING
Provider name: name
Description: The name of the resource, provided by the client when initially creating the resource. The resource 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.

network_interfaces

Type: UNORDERED_LIST_STRUCT
Provider name: networkInterfaces
Description: An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance.

  • 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 createc for first IP in associated external IPv6 range.
    • 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 createc for first IP in associated external IPv6 range.
    • 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
    • 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 be assigned IPv4 address.
  • 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

  • total_egress_bandwidth_tier
    Type: STRING
    Provider name: totalEgressBandwidthTier

organization_id

Type: STRING

params

Type: STRUCT
Provider name: params
Description: Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

parent

Type: STRING

private_ipv6_google_access

Type: STRING
Provider name: privateIpv6GoogleAccess
Description: The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default.
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.

project_id

Type: STRING

project_number

Type: STRING

reservation_affinity

Type: STRUCT
Provider name: reservationAffinity
Description: Specifies the reservations that this instance can consume from.

  • 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_name

Type: STRING

resource_policies

Type: UNORDERED_LIST_STRING
Provider name: resourcePolicies
Description: Resource policies applied to this instance.

resource_status

Type: STRUCT
Provider name: resourceStatus
Description: [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field.

  • physical_host
    Type: STRING
    Provider name: physicalHost
    Description: [Output Only] An opaque ID of the host on which the VM is running.

satisfies_pzs

Type: BOOLEAN
Provider name: satisfiesPzs
Description: [Output Only] Reserved for future use.

scheduling

Type: STRUCT
Provider name: scheduling
Description: Sets the scheduling options for this instance.

  • 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.
  • 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.
  • 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.
  • 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.
  • 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:
    • SPOT - Heavily discounted, no guaranteed runtime.
    • STANDARD - Standard provisioning with user controlled runtime, no discounts.

Type: STRING
Provider name: selfLink
Description: [Output Only] Server-defined URL for this resource.

service_accounts

Type: UNORDERED_LIST_STRUCT
Provider name: serviceAccounts
Description: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information.

  • 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

  • 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.

shielded_instance_integrity_policy

Type: STRUCT
Provider name: shieldedInstanceIntegrityPolicy

  • update_auto_learn_policy
    Type: BOOLEAN
    Provider name: updateAutoLearnPolicy
    Description: Updates the integrity policy baseline using the measurements from the VM instance’s most recent boot.

source_machine_image

Type: STRING
Provider name: sourceMachineImage
Description: Source machine image

source_machine_image_encryption_key

Type: STRUCT
Provider name: sourceMachineImageEncryptionKey
Description: Source machine image encryption key when creating an instance from a machine image.

  • 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.

start_restricted

Type: BOOLEAN
Provider name: startRestricted
Description: [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity.

status_message

Type: STRING
Provider name: statusMessage
Description: [Output Only] An optional, human-readable explanation of the status.

tags

Type: UNORDERED_LIST_STRING

zone

Type: STRING
Provider name: zone
Description: [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

PREVIEWING: piotr_wolski/update-dsm-docs