Idem.GCP.COMPUTE.INSTANCE
{
"account": "string",
"advanced_machine_features": {
"enable_nested_virtualization": false,
"enable_uefi_networking": false,
"threads_per_core": 0,
"visible_core_count": 0
},
"can_ip_forward": false,
"confidential_instance_config": {
"enable_confidential_compute": false
},
"count": 0,
"deletion_protection": false,
"description": "string",
"disks": [
{
"architecture": "string",
"auto_delete": false,
"boot": false,
"device_name": "string",
"disk_encryption_key": {
"kms_key_name": "string",
"kms_key_service_account": "string",
"raw_key": "string",
"rsa_encrypted_key": "string",
"sha256": "string"
},
"disk_size_gb": "string",
"force_attach": false,
"guest_os_features": [
{}
],
"index": 0,
"initialize_params": {
"architecture": "string",
"description": "string",
"disk_name": "string",
"disk_size_gb": "string",
"disk_type": "string",
"licenses": [
"string"
],
"on_update_action": "string",
"provisioned_iops": "string",
"resource_policies": [
"string"
],
"source_image": "string",
"source_image_encryption_key": {
"kms_key_name": "string",
"kms_key_service_account": "string",
"raw_key": "string",
"rsa_encrypted_key": "string",
"sha256": "string"
},
"source_snapshot": "string",
"source_snapshot_encryption_key": {
"kms_key_name": "string",
"kms_key_service_account": "string",
"raw_key": "string",
"rsa_encrypted_key": "string",
"sha256": "string"
}
},
"interface": "string",
"kind": "string",
"licenses": [
{}
],
"mode": "string",
"shielded_instance_initial_state": {
"dbs": [
{
"content": "string",
"file_type": "string"
}
],
"dbxs": [
{
"content": "string",
"file_type": "string"
}
],
"keks": [
{
"content": "string",
"file_type": "string"
}
],
"pk": {
"content": "string",
"file_type": "string"
}
},
"source": "string"
}
],
"display_device": {
"enable_display": false
},
"fingerprint": "string",
"guest_accelerators": [
{
"accelerator_count": 0,
"accelerator_type": "string"
}
],
"hostname": "string",
"id_": "string",
"key_revocation_action_type": "string",
"label_fingerprint": "string",
"machine_type": "string",
"metadata": {
"fingerprint": "string",
"items": [
{
"key": "string",
"value": "string"
}
],
"kind": "string"
},
"min_cpu_platform": "string",
"minimal_action": "string",
"most_disruptive_allowed_action": "string",
"name": "string",
"network_interfaces": [
{
"access_configs": [
{
"external_ipv6": "string",
"external_ipv6_prefix_length": 0,
"kind": "string",
"name": "string",
"nat_ip": "string",
"network_tier": "string",
"public_ptr_domain_name": "string",
"set_public_ptr": false
}
],
"alias_ip_ranges": [
{
"ip_cidr_range": "string",
"subnetwork_range_name": "string"
}
],
"fingerprint": "string",
"internal_ipv6_prefix_length": 0,
"ipv6_access_configs": [
{
"external_ipv6": "string",
"external_ipv6_prefix_length": 0,
"kind": "string",
"name": "string",
"nat_ip": "string",
"network_tier": "string",
"public_ptr_domain_name": "string",
"set_public_ptr": false
}
],
"ipv6_access_type": "string",
"ipv6_address": "string",
"kind": "string",
"name": "string",
"network": "string",
"network_ip": "string",
"nic_type": "string",
"queue_count": 0,
"stack_type": "string",
"subnetwork": "string"
}
],
"network_performance_config": {
"total_egress_bandwidth_tier": "string"
},
"params": {},
"private_ipv6_google_access": "string",
"project": "string",
"request_id": "string",
"reservation_affinity": {
"consume_reservation_type": "string",
"key": "string",
"values": [
"string"
]
},
"resource_id": "string",
"resource_policies": [
"string"
],
"scheduling": {
"automatic_restart": false,
"instance_termination_action": "string",
"location_hint": "string",
"min_node_cpus": 0,
"node_affinities": [
{
"key": "string",
"operator": "string",
"values": [
"string"
]
}
],
"on_host_maintenance": "string",
"preemptible": false,
"provisioning_model": "string"
},
"service_accounts": [
{
"email": "string",
"scopes": [
{}
]
}
],
"shielded_instance_config": {
"enable_integrity_monitoring": false,
"enable_secure_boot": false,
"enable_vtpm": false
},
"shielded_instance_integrity_policy": {
"update_auto_learn_policy": false
},
"source_instance_template": "string",
"source_machine_image": "string",
"source_machine_image_encryption_key": {
"kms_key_name": "string",
"kms_key_service_account": "string",
"raw_key": "string",
"rsa_encrypted_key": "string",
"sha256": "string"
},
"status": "string",
"tags": {
"fingerprint": "string",
"items": [
"string"
]
},
"zone": "string"
}The name of the vRA cloud account to use during provisioning
Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). Defaults to None.
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 . Defaults to None.
ConfidentialInstanceConfig: A set of Confidential Instance options. Defaults to None.
The number of resource instances to be created.
Whether the resource should be protected against deletion. Defaults to None.
An optional description of this resource. Provide this property when you create the resource. Defaults to None.
Array of disks associated with this instance. Persistent disks must be created before you can assign them. Defaults to None.
Enables display device for the instance. DisplayDevice: A set of Display Device options. Defaults to None.
Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. Defaults to None.
A list of the type and count of accelerator cards attached to the instance. Defaults to None.
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. Defaults to None.
The unique identifier for the resource. This identifier is defined by the server. Read-only property
KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Enum type. Allowed 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. Defaults to None.
A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. Defaults to None.
Labels to apply to this instance. These can be later modified by the setLabels method. Defaults to None.
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. Defaults to None.
The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. Metadata: A metadata key/value entry. Defaults to None.
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". Defaults to None.
Specifies the action to take when updating an instance even if the updated properties do not require it. If not specified, then Compute Engine acts based on the minimum action that the updated properties require. Defaults to None.
Specifies the most disruptive action that can be taken on the instance as part of the update. Compute Engine returns an error if the instance properties require a more disruptive action as part of the instance update. Valid options from lowest to highest are NO_EFFECT, REFRESH, and RESTART. Defaults to None.
An Idem name of the resource.
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. Defaults to None.
Defaults to None.
Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload. InstanceParams: Additional instance params. Defaults to None.
The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. Enum type. Allowed 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. Defaults to None.
Project ID for this request.
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). Defaults to None.
Specifies the reservations that this instance can consume from. ReservationAffinity: Specifies the reservations that this instance can consume from. Defaults to None.
An identifier of the resource in the provider. Defaults to None.
Resource policies applied to this instance. Defaults to None.
Sets the scheduling options for this instance. Scheduling: Sets the scheduling options for an Instance. Defaults to None.
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. Defaults to None.
ShieldedInstanceConfig: A set of Shielded Instance options. Defaults to None.
ShieldedInstanceIntegrityPolicy: The policy describes the baseline against which Instance boot integrity is measured. Defaults to None.
Specifies instance template to create the instance. This field is optional. It can be a full or partial URL. For example, the following are all valid URLs to an instance template:
- https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate
- projects/project/global/instanceTemplates/instanceTemplate
- global/instanceTemplates/instanceTemplate
Defaults to None.
source_machine_image
Source machine image encryption key when creating an instance from a machine image. Defaults to None.
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. Enum type. Allowed values: "DEPROVISIONING" - The Nanny 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). Defaults to None.
Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. Tags: A set of instance tags. Defaults to None.
The name of the zone for this request.