Google Cloud Classic v6.57.0, May 30 23
Google Cloud Classic v6.57.0, May 30 23
gcp.compute.InstanceFromMachineImage
Explore with Pulumi AI
Manages a VM instance resource within GCE. For more information see the official documentation and API.
This resource is specifically to create a compute instance from a given
source_machine_image
. To create an instance without a machine image, use the
gcp.compute.Instance
resource.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var tpl = new Gcp.Compute.InstanceFromMachineImage("tpl", new()
{
Zone = "us-central1-a",
SourceMachineImage = "projects/PROJECT-ID/global/machineImages/NAME",
CanIpForward = false,
Labels =
{
{ "my_key", "my_value" },
},
}, new CustomResourceOptions
{
Provider = google_beta,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v6/go/gcp/compute"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewInstanceFromMachineImage(ctx, "tpl", &compute.InstanceFromMachineImageArgs{
Zone: pulumi.String("us-central1-a"),
SourceMachineImage: pulumi.String("projects/PROJECT-ID/global/machineImages/NAME"),
CanIpForward: pulumi.Bool(false),
Labels: pulumi.StringMap{
"my_key": pulumi.String("my_value"),
},
}, pulumi.Provider(google_beta))
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.InstanceFromMachineImage;
import com.pulumi.gcp.compute.InstanceFromMachineImageArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var tpl = new InstanceFromMachineImage("tpl", InstanceFromMachineImageArgs.builder()
.zone("us-central1-a")
.sourceMachineImage("projects/PROJECT-ID/global/machineImages/NAME")
.canIpForward(false)
.labels(Map.of("my_key", "my_value"))
.build(), CustomResourceOptions.builder()
.provider(google_beta)
.build());
}
}
import pulumi
import pulumi_gcp as gcp
tpl = gcp.compute.InstanceFromMachineImage("tpl",
zone="us-central1-a",
source_machine_image="projects/PROJECT-ID/global/machineImages/NAME",
can_ip_forward=False,
labels={
"my_key": "my_value",
},
opts=pulumi.ResourceOptions(provider=google_beta))
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const tpl = new gcp.compute.InstanceFromMachineImage("tpl", {
zone: "us-central1-a",
sourceMachineImage: "projects/PROJECT-ID/global/machineImages/NAME",
canIpForward: false,
labels: {
my_key: "my_value",
},
}, {
provider: google_beta,
});
resources:
tpl:
type: gcp:compute:InstanceFromMachineImage
properties:
zone: us-central1-a
sourceMachineImage: projects/PROJECT-ID/global/machineImages/NAME
# Override fields from machine image
canIpForward: false
labels:
my_key: my_value
options:
provider: ${["google-beta"]}
Create InstanceFromMachineImage Resource
new InstanceFromMachineImage(name: string, args: InstanceFromMachineImageArgs, opts?: CustomResourceOptions);
@overload
def InstanceFromMachineImage(resource_name: str,
opts: Optional[ResourceOptions] = None,
advanced_machine_features: Optional[InstanceFromMachineImageAdvancedMachineFeaturesArgs] = None,
allow_stopping_for_update: Optional[bool] = None,
can_ip_forward: Optional[bool] = None,
confidential_instance_config: Optional[InstanceFromMachineImageConfidentialInstanceConfigArgs] = None,
deletion_protection: Optional[bool] = None,
description: Optional[str] = None,
desired_status: Optional[str] = None,
enable_display: Optional[bool] = None,
guest_accelerators: Optional[Sequence[InstanceFromMachineImageGuestAcceleratorArgs]] = None,
hostname: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
machine_type: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
metadata_startup_script: Optional[str] = None,
min_cpu_platform: Optional[str] = None,
name: Optional[str] = None,
network_interfaces: Optional[Sequence[InstanceFromMachineImageNetworkInterfaceArgs]] = None,
network_performance_config: Optional[InstanceFromMachineImageNetworkPerformanceConfigArgs] = None,
project: Optional[str] = None,
reservation_affinity: Optional[InstanceFromMachineImageReservationAffinityArgs] = None,
resource_policies: Optional[str] = None,
scheduling: Optional[InstanceFromMachineImageSchedulingArgs] = None,
service_account: Optional[InstanceFromMachineImageServiceAccountArgs] = None,
shielded_instance_config: Optional[InstanceFromMachineImageShieldedInstanceConfigArgs] = None,
source_machine_image: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
zone: Optional[str] = None)
@overload
def InstanceFromMachineImage(resource_name: str,
args: InstanceFromMachineImageArgs,
opts: Optional[ResourceOptions] = None)
func NewInstanceFromMachineImage(ctx *Context, name string, args InstanceFromMachineImageArgs, opts ...ResourceOption) (*InstanceFromMachineImage, error)
public InstanceFromMachineImage(string name, InstanceFromMachineImageArgs args, CustomResourceOptions? opts = null)
public InstanceFromMachineImage(String name, InstanceFromMachineImageArgs args)
public InstanceFromMachineImage(String name, InstanceFromMachineImageArgs args, CustomResourceOptions options)
type: gcp:compute:InstanceFromMachineImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceFromMachineImageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args InstanceFromMachineImageArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args InstanceFromMachineImageArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args InstanceFromMachineImageArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args InstanceFromMachineImageArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
InstanceFromMachineImage Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The InstanceFromMachineImage resource accepts the following input properties:
- Source
Machine stringImage Name or self link of a machine image to create the instance based on.
- Advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- Allow
Stopping boolFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- Can
Ip boolForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- Confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- Deletion
Protection bool Whether deletion protection is enabled on this instance.
- Description string
A brief description of the resource.
- Desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- Enable
Display bool Whether the instance has virtual displays enabled.
- Guest
Accelerators List<InstanceFrom Machine Image Guest Accelerator Args> List of the type and count of accelerator cards attached to the instance.
- Hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- Labels Dictionary<string, string>
A set of key/value label pairs assigned to the instance.
- Machine
Type string The machine type to create.
- Metadata Dictionary<string, string>
Metadata key/value pairs made available within the instance.
- Metadata
Startup stringScript Metadata startup scripts made available within the instance.
- Min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network
Interfaces List<InstanceFrom Machine Image Network Interface Args> The networks attached to the instance.
- Network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- Project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- Reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- Resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- Scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- Service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- Shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- List<string>
The list of tags attached to the instance.
- Zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- Source
Machine stringImage Name or self link of a machine image to create the instance based on.
- Advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- Allow
Stopping boolFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- Can
Ip boolForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- Confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- Deletion
Protection bool Whether deletion protection is enabled on this instance.
- Description string
A brief description of the resource.
- Desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- Enable
Display bool Whether the instance has virtual displays enabled.
- Guest
Accelerators []InstanceFrom Machine Image Guest Accelerator Args List of the type and count of accelerator cards attached to the instance.
- Hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- Labels map[string]string
A set of key/value label pairs assigned to the instance.
- Machine
Type string The machine type to create.
- Metadata map[string]string
Metadata key/value pairs made available within the instance.
- Metadata
Startup stringScript Metadata startup scripts made available within the instance.
- Min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network
Interfaces []InstanceFrom Machine Image Network Interface Args The networks attached to the instance.
- Network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- Project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- Reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- Resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- Scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- Service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- Shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- []string
The list of tags attached to the instance.
- Zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- source
Machine StringImage Name or self link of a machine image to create the instance based on.
- advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow
Stopping BooleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- can
Ip BooleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- deletion
Protection Boolean Whether deletion protection is enabled on this instance.
- description String
A brief description of the resource.
- desired
Status String Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display Boolean Whether the instance has virtual displays enabled.
- guest
Accelerators List<InstanceFrom Machine Image Guest Accelerator Args> List of the type and count of accelerator cards attached to the instance.
- hostname String
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- labels Map<String,String>
A set of key/value label pairs assigned to the instance.
- machine
Type String The machine type to create.
- metadata Map<String,String>
Metadata key/value pairs made available within the instance.
- metadata
Startup StringScript Metadata startup scripts made available within the instance.
- min
Cpu StringPlatform The minimum CPU platform specified for the VM instance.
- name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces List<InstanceFrom Machine Image Network Interface Args> The networks attached to the instance.
- network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project String
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource
Policies String A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- List<String>
The list of tags attached to the instance.
- zone String
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- source
Machine stringImage Name or self link of a machine image to create the instance based on.
- advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow
Stopping booleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- can
Ip booleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- deletion
Protection boolean Whether deletion protection is enabled on this instance.
- description string
A brief description of the resource.
- desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display boolean Whether the instance has virtual displays enabled.
- guest
Accelerators InstanceFrom Machine Image Guest Accelerator Args[] List of the type and count of accelerator cards attached to the instance.
- hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- labels {[key: string]: string}
A set of key/value label pairs assigned to the instance.
- machine
Type string The machine type to create.
- metadata {[key: string]: string}
Metadata key/value pairs made available within the instance.
- metadata
Startup stringScript Metadata startup scripts made available within the instance.
- min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces InstanceFrom Machine Image Network Interface Args[] The networks attached to the instance.
- network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- string[]
The list of tags attached to the instance.
- zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- source_
machine_ strimage Name or self link of a machine image to create the instance based on.
- advanced_
machine_ Instancefeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow_
stopping_ boolfor_ update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- can_
ip_ boolforward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential_
instance_ Instanceconfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- deletion_
protection bool Whether deletion protection is enabled on this instance.
- description str
A brief description of the resource.
- desired_
status str Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable_
display bool Whether the instance has virtual displays enabled.
- guest_
accelerators Sequence[InstanceFrom Machine Image Guest Accelerator Args] List of the type and count of accelerator cards attached to the instance.
- hostname str
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- labels Mapping[str, str]
A set of key/value label pairs assigned to the instance.
- machine_
type str The machine type to create.
- metadata Mapping[str, str]
Metadata key/value pairs made available within the instance.
- metadata_
startup_ strscript Metadata startup scripts made available within the instance.
- min_
cpu_ strplatform The minimum CPU platform specified for the VM instance.
- name str
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network_
interfaces Sequence[InstanceFrom Machine Image Network Interface Args] The networks attached to the instance.
- network_
performance_ Instanceconfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project str
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation_
affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource_
policies str A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- service_
account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded_
instance_ Instanceconfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- Sequence[str]
The list of tags attached to the instance.
- zone str
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- source
Machine StringImage Name or self link of a machine image to create the instance based on.
- advanced
Machine Property MapFeatures Controls for advanced machine-related behavior features.
- allow
Stopping BooleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- can
Ip BooleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance Property MapConfig The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- deletion
Protection Boolean Whether deletion protection is enabled on this instance.
- description String
A brief description of the resource.
- desired
Status String Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display Boolean Whether the instance has virtual displays enabled.
- guest
Accelerators List<Property Map> List of the type and count of accelerator cards attached to the instance.
- hostname String
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- labels Map<String>
A set of key/value label pairs assigned to the instance.
- machine
Type String The machine type to create.
- metadata Map<String>
Metadata key/value pairs made available within the instance.
- metadata
Startup StringScript Metadata startup scripts made available within the instance.
- min
Cpu StringPlatform The minimum CPU platform specified for the VM instance.
- name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> The networks attached to the instance.
- network
Performance Property MapConfig Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project String
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity Property Map Specifies the reservations that this instance can consume from.
- resource
Policies String A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling Property Map
The scheduling strategy being used by the instance.
- service
Account Property Map The service account to attach to the instance.
- shielded
Instance Property MapConfig The shielded vm config being used by the instance.
- List<String>
The list of tags attached to the instance.
- zone String
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
Outputs
All input properties are implicitly available as output properties. Additionally, the InstanceFromMachineImage resource produces the following output properties:
- Attached
Disks List<InstanceFrom Machine Image Attached Disk> List of disks attached to the instance
- Boot
Disks List<InstanceFrom Machine Image Boot Disk> The boot disk for the instance.
- Cpu
Platform string The CPU platform used by this instance.
- Current
Status string Current status of the instance. This could be 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Id string The server-assigned unique identifier of this instance.
- Label
Fingerprint string The unique fingerprint of the labels.
- Metadata
Fingerprint string The unique fingerprint of the metadata.
- Scratch
Disks List<InstanceFrom Machine Image Scratch Disk> The scratch disks attached to the instance.
- Self
Link string The URI of the created resource.
- string
The unique fingerprint of the tags.
- Attached
Disks []InstanceFrom Machine Image Attached Disk List of disks attached to the instance
- Boot
Disks []InstanceFrom Machine Image Boot Disk The boot disk for the instance.
- Cpu
Platform string The CPU platform used by this instance.
- Current
Status string Current status of the instance. This could be 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.
- Id string
The provider-assigned unique ID for this managed resource.
- Instance
Id string The server-assigned unique identifier of this instance.
- Label
Fingerprint string The unique fingerprint of the labels.
- Metadata
Fingerprint string The unique fingerprint of the metadata.
- Scratch
Disks []InstanceFrom Machine Image Scratch Disk The scratch disks attached to the instance.
- Self
Link string The URI of the created resource.
- string
The unique fingerprint of the tags.
- attached
Disks List<InstanceFrom Machine Image Attached Disk> List of disks attached to the instance
- boot
Disks List<InstanceFrom Machine Image Boot Disk> The boot disk for the instance.
- cpu
Platform String The CPU platform used by this instance.
- current
Status String Current status of the instance. This could be 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.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Id String The server-assigned unique identifier of this instance.
- label
Fingerprint String The unique fingerprint of the labels.
- metadata
Fingerprint String The unique fingerprint of the metadata.
- scratch
Disks List<InstanceFrom Machine Image Scratch Disk> The scratch disks attached to the instance.
- self
Link String The URI of the created resource.
- String
The unique fingerprint of the tags.
- attached
Disks InstanceFrom Machine Image Attached Disk[] List of disks attached to the instance
- boot
Disks InstanceFrom Machine Image Boot Disk[] The boot disk for the instance.
- cpu
Platform string The CPU platform used by this instance.
- current
Status string Current status of the instance. This could be 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.
- id string
The provider-assigned unique ID for this managed resource.
- instance
Id string The server-assigned unique identifier of this instance.
- label
Fingerprint string The unique fingerprint of the labels.
- metadata
Fingerprint string The unique fingerprint of the metadata.
- scratch
Disks InstanceFrom Machine Image Scratch Disk[] The scratch disks attached to the instance.
- self
Link string The URI of the created resource.
- string
The unique fingerprint of the tags.
- attached_
disks Sequence[InstanceFrom Machine Image Attached Disk] List of disks attached to the instance
- boot_
disks Sequence[InstanceFrom Machine Image Boot Disk] The boot disk for the instance.
- cpu_
platform str The CPU platform used by this instance.
- current_
status str Current status of the instance. This could be 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.
- id str
The provider-assigned unique ID for this managed resource.
- instance_
id str The server-assigned unique identifier of this instance.
- label_
fingerprint str The unique fingerprint of the labels.
- metadata_
fingerprint str The unique fingerprint of the metadata.
- scratch_
disks Sequence[InstanceFrom Machine Image Scratch Disk] The scratch disks attached to the instance.
- self_
link str The URI of the created resource.
- str
The unique fingerprint of the tags.
- attached
Disks List<Property Map> List of disks attached to the instance
- boot
Disks List<Property Map> The boot disk for the instance.
- cpu
Platform String The CPU platform used by this instance.
- current
Status String Current status of the instance. This could be 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.
- id String
The provider-assigned unique ID for this managed resource.
- instance
Id String The server-assigned unique identifier of this instance.
- label
Fingerprint String The unique fingerprint of the labels.
- metadata
Fingerprint String The unique fingerprint of the metadata.
- scratch
Disks List<Property Map> The scratch disks attached to the instance.
- self
Link String The URI of the created resource.
- String
The unique fingerprint of the tags.
Look up Existing InstanceFromMachineImage Resource
Get an existing InstanceFromMachineImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: InstanceFromMachineImageState, opts?: CustomResourceOptions): InstanceFromMachineImage
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
advanced_machine_features: Optional[InstanceFromMachineImageAdvancedMachineFeaturesArgs] = None,
allow_stopping_for_update: Optional[bool] = None,
attached_disks: Optional[Sequence[InstanceFromMachineImageAttachedDiskArgs]] = None,
boot_disks: Optional[Sequence[InstanceFromMachineImageBootDiskArgs]] = None,
can_ip_forward: Optional[bool] = None,
confidential_instance_config: Optional[InstanceFromMachineImageConfidentialInstanceConfigArgs] = None,
cpu_platform: Optional[str] = None,
current_status: Optional[str] = None,
deletion_protection: Optional[bool] = None,
description: Optional[str] = None,
desired_status: Optional[str] = None,
enable_display: Optional[bool] = None,
guest_accelerators: Optional[Sequence[InstanceFromMachineImageGuestAcceleratorArgs]] = None,
hostname: Optional[str] = None,
instance_id: Optional[str] = None,
label_fingerprint: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
machine_type: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
metadata_fingerprint: Optional[str] = None,
metadata_startup_script: Optional[str] = None,
min_cpu_platform: Optional[str] = None,
name: Optional[str] = None,
network_interfaces: Optional[Sequence[InstanceFromMachineImageNetworkInterfaceArgs]] = None,
network_performance_config: Optional[InstanceFromMachineImageNetworkPerformanceConfigArgs] = None,
project: Optional[str] = None,
reservation_affinity: Optional[InstanceFromMachineImageReservationAffinityArgs] = None,
resource_policies: Optional[str] = None,
scheduling: Optional[InstanceFromMachineImageSchedulingArgs] = None,
scratch_disks: Optional[Sequence[InstanceFromMachineImageScratchDiskArgs]] = None,
self_link: Optional[str] = None,
service_account: Optional[InstanceFromMachineImageServiceAccountArgs] = None,
shielded_instance_config: Optional[InstanceFromMachineImageShieldedInstanceConfigArgs] = None,
source_machine_image: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
tags_fingerprint: Optional[str] = None,
zone: Optional[str] = None) -> InstanceFromMachineImage
func GetInstanceFromMachineImage(ctx *Context, name string, id IDInput, state *InstanceFromMachineImageState, opts ...ResourceOption) (*InstanceFromMachineImage, error)
public static InstanceFromMachineImage Get(string name, Input<string> id, InstanceFromMachineImageState? state, CustomResourceOptions? opts = null)
public static InstanceFromMachineImage get(String name, Output<String> id, InstanceFromMachineImageState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- Allow
Stopping boolFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- Attached
Disks List<InstanceFrom Machine Image Attached Disk Args> List of disks attached to the instance
- Boot
Disks List<InstanceFrom Machine Image Boot Disk Args> The boot disk for the instance.
- Can
Ip boolForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- Confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- Cpu
Platform string The CPU platform used by this instance.
- Current
Status string Current status of the instance. This could be 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.
- Deletion
Protection bool Whether deletion protection is enabled on this instance.
- Description string
A brief description of the resource.
- Desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- Enable
Display bool Whether the instance has virtual displays enabled.
- Guest
Accelerators List<InstanceFrom Machine Image Guest Accelerator Args> List of the type and count of accelerator cards attached to the instance.
- Hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- Instance
Id string The server-assigned unique identifier of this instance.
- Label
Fingerprint string The unique fingerprint of the labels.
- Labels Dictionary<string, string>
A set of key/value label pairs assigned to the instance.
- Machine
Type string The machine type to create.
- Metadata Dictionary<string, string>
Metadata key/value pairs made available within the instance.
- Metadata
Fingerprint string The unique fingerprint of the metadata.
- Metadata
Startup stringScript Metadata startup scripts made available within the instance.
- Min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network
Interfaces List<InstanceFrom Machine Image Network Interface Args> The networks attached to the instance.
- Network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- Project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- Reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- Resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- Scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- Scratch
Disks List<InstanceFrom Machine Image Scratch Disk Args> The scratch disks attached to the instance.
- Self
Link string The URI of the created resource.
- Service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- Shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- Source
Machine stringImage Name or self link of a machine image to create the instance based on.
- List<string>
The list of tags attached to the instance.
- string
The unique fingerprint of the tags.
- Zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- Advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- Allow
Stopping boolFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- Attached
Disks []InstanceFrom Machine Image Attached Disk Args List of disks attached to the instance
- Boot
Disks []InstanceFrom Machine Image Boot Disk Args The boot disk for the instance.
- Can
Ip boolForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- Confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- Cpu
Platform string The CPU platform used by this instance.
- Current
Status string Current status of the instance. This could be 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.
- Deletion
Protection bool Whether deletion protection is enabled on this instance.
- Description string
A brief description of the resource.
- Desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- Enable
Display bool Whether the instance has virtual displays enabled.
- Guest
Accelerators []InstanceFrom Machine Image Guest Accelerator Args List of the type and count of accelerator cards attached to the instance.
- Hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- Instance
Id string The server-assigned unique identifier of this instance.
- Label
Fingerprint string The unique fingerprint of the labels.
- Labels map[string]string
A set of key/value label pairs assigned to the instance.
- Machine
Type string The machine type to create.
- Metadata map[string]string
Metadata key/value pairs made available within the instance.
- Metadata
Fingerprint string The unique fingerprint of the metadata.
- Metadata
Startup stringScript Metadata startup scripts made available within the instance.
- Min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network
Interfaces []InstanceFrom Machine Image Network Interface Args The networks attached to the instance.
- Network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- Project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- Reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- Resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- Scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- Scratch
Disks []InstanceFrom Machine Image Scratch Disk Args The scratch disks attached to the instance.
- Self
Link string The URI of the created resource.
- Service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- Shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- Source
Machine stringImage Name or self link of a machine image to create the instance based on.
- []string
The list of tags attached to the instance.
- string
The unique fingerprint of the tags.
- Zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow
Stopping BooleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- attached
Disks List<InstanceFrom Machine Image Attached Disk Args> List of disks attached to the instance
- boot
Disks List<InstanceFrom Machine Image Boot Disk Args> The boot disk for the instance.
- can
Ip BooleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- cpu
Platform String The CPU platform used by this instance.
- current
Status String Current status of the instance. This could be 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.
- deletion
Protection Boolean Whether deletion protection is enabled on this instance.
- description String
A brief description of the resource.
- desired
Status String Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display Boolean Whether the instance has virtual displays enabled.
- guest
Accelerators List<InstanceFrom Machine Image Guest Accelerator Args> List of the type and count of accelerator cards attached to the instance.
- hostname String
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- instance
Id String The server-assigned unique identifier of this instance.
- label
Fingerprint String The unique fingerprint of the labels.
- labels Map<String,String>
A set of key/value label pairs assigned to the instance.
- machine
Type String The machine type to create.
- metadata Map<String,String>
Metadata key/value pairs made available within the instance.
- metadata
Fingerprint String The unique fingerprint of the metadata.
- metadata
Startup StringScript Metadata startup scripts made available within the instance.
- min
Cpu StringPlatform The minimum CPU platform specified for the VM instance.
- name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces List<InstanceFrom Machine Image Network Interface Args> The networks attached to the instance.
- network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project String
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource
Policies String A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- scratch
Disks List<InstanceFrom Machine Image Scratch Disk Args> The scratch disks attached to the instance.
- self
Link String The URI of the created resource.
- service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- source
Machine StringImage Name or self link of a machine image to create the instance based on.
- List<String>
The list of tags attached to the instance.
- String
The unique fingerprint of the tags.
- zone String
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- advanced
Machine InstanceFeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow
Stopping booleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- attached
Disks InstanceFrom Machine Image Attached Disk Args[] List of disks attached to the instance
- boot
Disks InstanceFrom Machine Image Boot Disk Args[] The boot disk for the instance.
- can
Ip booleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance InstanceConfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- cpu
Platform string The CPU platform used by this instance.
- current
Status string Current status of the instance. This could be 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.
- deletion
Protection boolean Whether deletion protection is enabled on this instance.
- description string
A brief description of the resource.
- desired
Status string Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display boolean Whether the instance has virtual displays enabled.
- guest
Accelerators InstanceFrom Machine Image Guest Accelerator Args[] List of the type and count of accelerator cards attached to the instance.
- hostname string
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- instance
Id string The server-assigned unique identifier of this instance.
- label
Fingerprint string The unique fingerprint of the labels.
- labels {[key: string]: string}
A set of key/value label pairs assigned to the instance.
- machine
Type string The machine type to create.
- metadata {[key: string]: string}
Metadata key/value pairs made available within the instance.
- metadata
Fingerprint string The unique fingerprint of the metadata.
- metadata
Startup stringScript Metadata startup scripts made available within the instance.
- min
Cpu stringPlatform The minimum CPU platform specified for the VM instance.
- name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces InstanceFrom Machine Image Network Interface Args[] The networks attached to the instance.
- network
Performance InstanceConfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project string
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource
Policies string A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- scratch
Disks InstanceFrom Machine Image Scratch Disk Args[] The scratch disks attached to the instance.
- self
Link string The URI of the created resource.
- service
Account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded
Instance InstanceConfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- source
Machine stringImage Name or self link of a machine image to create the instance based on.
- string[]
The list of tags attached to the instance.
- string
The unique fingerprint of the tags.
- zone string
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- advanced_
machine_ Instancefeatures From Machine Image Advanced Machine Features Args Controls for advanced machine-related behavior features.
- allow_
stopping_ boolfor_ update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- attached_
disks Sequence[InstanceFrom Machine Image Attached Disk Args] List of disks attached to the instance
- boot_
disks Sequence[InstanceFrom Machine Image Boot Disk Args] The boot disk for the instance.
- can_
ip_ boolforward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential_
instance_ Instanceconfig From Machine Image Confidential Instance Config Args The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- cpu_
platform str The CPU platform used by this instance.
- current_
status str Current status of the instance. This could be 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.
- deletion_
protection bool Whether deletion protection is enabled on this instance.
- description str
A brief description of the resource.
- desired_
status str Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable_
display bool Whether the instance has virtual displays enabled.
- guest_
accelerators Sequence[InstanceFrom Machine Image Guest Accelerator Args] List of the type and count of accelerator cards attached to the instance.
- hostname str
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- instance_
id str The server-assigned unique identifier of this instance.
- label_
fingerprint str The unique fingerprint of the labels.
- labels Mapping[str, str]
A set of key/value label pairs assigned to the instance.
- machine_
type str The machine type to create.
- metadata Mapping[str, str]
Metadata key/value pairs made available within the instance.
- metadata_
fingerprint str The unique fingerprint of the metadata.
- metadata_
startup_ strscript Metadata startup scripts made available within the instance.
- min_
cpu_ strplatform The minimum CPU platform specified for the VM instance.
- name str
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network_
interfaces Sequence[InstanceFrom Machine Image Network Interface Args] The networks attached to the instance.
- network_
performance_ Instanceconfig From Machine Image Network Performance Config Args Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project str
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation_
affinity InstanceFrom Machine Image Reservation Affinity Args Specifies the reservations that this instance can consume from.
- resource_
policies str A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling
Instance
From Machine Image Scheduling Args The scheduling strategy being used by the instance.
- scratch_
disks Sequence[InstanceFrom Machine Image Scratch Disk Args] The scratch disks attached to the instance.
- self_
link str The URI of the created resource.
- service_
account InstanceFrom Machine Image Service Account Args The service account to attach to the instance.
- shielded_
instance_ Instanceconfig From Machine Image Shielded Instance Config Args The shielded vm config being used by the instance.
- source_
machine_ strimage Name or self link of a machine image to create the instance based on.
- Sequence[str]
The list of tags attached to the instance.
- str
The unique fingerprint of the tags.
- zone str
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
- advanced
Machine Property MapFeatures Controls for advanced machine-related behavior features.
- allow
Stopping BooleanFor Update If true, allows Terraform to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.
- attached
Disks List<Property Map> List of disks attached to the instance
- boot
Disks List<Property Map> The boot disk for the instance.
- can
Ip BooleanForward Whether sending and receiving of packets with non-matching source or destination IPs is allowed.
- confidential
Instance Property MapConfig The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.
- cpu
Platform String The CPU platform used by this instance.
- current
Status String Current status of the instance. This could be 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.
- deletion
Protection Boolean Whether deletion protection is enabled on this instance.
- description String
A brief description of the resource.
- desired
Status String Desired status of the instance. Either "RUNNING" or "TERMINATED".
- enable
Display Boolean Whether the instance has virtual displays enabled.
- guest
Accelerators List<Property Map> List of the type and count of accelerator cards attached to the instance.
- hostname String
A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.
- instance
Id String The server-assigned unique identifier of this instance.
- label
Fingerprint String The unique fingerprint of the labels.
- labels Map<String>
A set of key/value label pairs assigned to the instance.
- machine
Type String The machine type to create.
- metadata Map<String>
Metadata key/value pairs made available within the instance.
- metadata
Fingerprint String The unique fingerprint of the metadata.
- metadata
Startup StringScript Metadata startup scripts made available within the instance.
- min
Cpu StringPlatform The minimum CPU platform specified for the VM instance.
- name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network
Interfaces List<Property Map> The networks attached to the instance.
- network
Performance Property MapConfig Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.
- project String
The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.
- reservation
Affinity Property Map Specifies the reservations that this instance can consume from.
- resource
Policies String A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.
- scheduling Property Map
The scheduling strategy being used by the instance.
- scratch
Disks List<Property Map> The scratch disks attached to the instance.
- self
Link String The URI of the created resource.
- service
Account Property Map The service account to attach to the instance.
- shielded
Instance Property MapConfig The shielded vm config being used by the instance.
- source
Machine StringImage Name or self link of a machine image to create the instance based on.
- List<String>
The list of tags attached to the instance.
- String
The unique fingerprint of the tags.
- zone String
The zone that the machine should be created in. If not set, the provider zone is used.
In addition to these, most* arguments from
gcp.compute.Instance
are supported as a way to override the properties in the machine image. All exported attributes fromgcp.compute.Instance
are likewise exported here.Warning: *Due to API limitations, disk overrides are currently disabled. This includes the "boot_disk", "attached_disk", and "scratch_disk" fields.
Supporting Types
InstanceFromMachineImageAdvancedMachineFeatures
- enable
Nested BooleanVirtualization - threads
Per IntegerCore - visible
Core IntegerCount
- enable
Nested booleanVirtualization - threads
Per numberCore - visible
Core numberCount
- enable
Nested BooleanVirtualization - threads
Per NumberCore - visible
Core NumberCount
InstanceFromMachineImageAttachedDisk
- Source string
- Device
Name string - Disk
Encryption stringKey Raw - Disk
Encryption stringKey Sha256 - Kms
Key stringSelf Link - Mode string
- Source string
- Device
Name string - Disk
Encryption stringKey Raw - Disk
Encryption stringKey Sha256 - Kms
Key stringSelf Link - Mode string
- source String
- device
Name String - disk
Encryption StringKey Raw - disk
Encryption StringKey Sha256 - kms
Key StringSelf Link - mode String
- source string
- device
Name string - disk
Encryption stringKey Raw - disk
Encryption stringKey Sha256 - kms
Key stringSelf Link - mode string
- source str
- device_
name str - disk_
encryption_ strkey_ raw - disk_
encryption_ strkey_ sha256 - kms_
key_ strself_ link - mode str
- source String
- device
Name String - disk
Encryption StringKey Raw - disk
Encryption StringKey Sha256 - kms
Key StringSelf Link - mode String
InstanceFromMachineImageBootDisk
- Auto
Delete bool - Device
Name string - Disk
Encryption stringKey Raw - Disk
Encryption stringKey Sha256 - Initialize
Params InstanceFrom Machine Image Boot Disk Initialize Params - Kms
Key stringSelf Link - Mode string
- Source string
- Auto
Delete bool - Device
Name string - Disk
Encryption stringKey Raw - Disk
Encryption stringKey Sha256 - Initialize
Params InstanceFrom Machine Image Boot Disk Initialize Params - Kms
Key stringSelf Link - Mode string
- Source string
- auto
Delete Boolean - device
Name String - disk
Encryption StringKey Raw - disk
Encryption StringKey Sha256 - initialize
Params InstanceFrom Machine Image Boot Disk Initialize Params - kms
Key StringSelf Link - mode String
- source String
- auto
Delete boolean - device
Name string - disk
Encryption stringKey Raw - disk
Encryption stringKey Sha256 - initialize
Params InstanceFrom Machine Image Boot Disk Initialize Params - kms
Key stringSelf Link - mode string
- source string
- auto
Delete Boolean - device
Name String - disk
Encryption StringKey Raw - disk
Encryption StringKey Sha256 - initialize
Params Property Map - kms
Key StringSelf Link - mode String
- source String
InstanceFromMachineImageBootDiskInitializeParams
InstanceFromMachineImageConfidentialInstanceConfig
- enable
Confidential BooleanCompute
- enable
Confidential booleanCompute
- enable
Confidential BooleanCompute
InstanceFromMachineImageGuestAccelerator
InstanceFromMachineImageNetworkInterface
- Access
Configs List<InstanceFrom Machine Image Network Interface Access Config> - Alias
Ip List<InstanceRanges From Machine Image Network Interface Alias Ip Range> - Ipv6Access
Configs List<InstanceFrom Machine Image Network Interface Ipv6Access Config> - Ipv6Access
Type string - Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network string
- Network
Ip string - Nic
Type string - Queue
Count int - Stack
Type string - Subnetwork string
- Subnetwork
Project string
- Access
Configs []InstanceFrom Machine Image Network Interface Access Config - Alias
Ip []InstanceRanges From Machine Image Network Interface Alias Ip Range - Ipv6Access
Configs []InstanceFrom Machine Image Network Interface Ipv6Access Config - Ipv6Access
Type string - Name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- Network string
- Network
Ip string - Nic
Type string - Queue
Count int - Stack
Type string - Subnetwork string
- Subnetwork
Project string
- access
Configs List<InstanceFrom Machine Image Network Interface Access Config> - alias
Ip List<InstanceRanges From Machine Image Network Interface Alias Ip Range> - ipv6Access
Configs List<InstanceFrom Machine Image Network Interface Ipv6Access Config> - ipv6Access
Type String - name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network String
- network
Ip String - nic
Type String - queue
Count Integer - stack
Type String - subnetwork String
- subnetwork
Project String
- access
Configs InstanceFrom Machine Image Network Interface Access Config[] - alias
Ip InstanceRanges From Machine Image Network Interface Alias Ip Range[] - ipv6Access
Configs InstanceFrom Machine Image Network Interface Ipv6Access Config[] - ipv6Access
Type string - name string
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network string
- network
Ip string - nic
Type string - queue
Count number - stack
Type string - subnetwork string
- subnetwork
Project string
- access_
configs Sequence[InstanceFrom Machine Image Network Interface Access Config] - alias_
ip_ Sequence[Instanceranges From Machine Image Network Interface Alias Ip Range] - ipv6_
access_ Sequence[Instanceconfigs From Machine Image Network Interface Ipv6Access Config] - ipv6_
access_ strtype - name str
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network str
- network_
ip str - nic_
type str - queue_
count int - stack_
type str - subnetwork str
- subnetwork_
project str
- access
Configs List<Property Map> - alias
Ip List<Property Map>Ranges - ipv6Access
Configs List<Property Map> - ipv6Access
Type String - name String
A unique name for the resource, required by GCE. Changing this forces a new resource to be created.
- network String
- network
Ip String - nic
Type String - queue
Count Number - stack
Type String - subnetwork String
- subnetwork
Project String
InstanceFromMachineImageNetworkInterfaceAccessConfig
- Nat
Ip string - Network
Tier string - Public
Ptr stringDomain Name
- Nat
Ip string - Network
Tier string - Public
Ptr stringDomain Name
- nat
Ip String - network
Tier String - public
Ptr StringDomain Name
- nat
Ip string - network
Tier string - public
Ptr stringDomain Name
- nat_
ip str - network_
tier str - public_
ptr_ strdomain_ name
- nat
Ip String - network
Tier String - public
Ptr StringDomain Name
InstanceFromMachineImageNetworkInterfaceAliasIpRange
- Ip
Cidr stringRange - Subnetwork
Range stringName
- Ip
Cidr stringRange - Subnetwork
Range stringName
- ip
Cidr StringRange - subnetwork
Range StringName
- ip
Cidr stringRange - subnetwork
Range stringName
- ip
Cidr StringRange - subnetwork
Range StringName
InstanceFromMachineImageNetworkInterfaceIpv6AccessConfig
- Network
Tier string - External
Ipv6 string - External
Ipv6Prefix stringLength - Public
Ptr stringDomain Name
- Network
Tier string - External
Ipv6 string - External
Ipv6Prefix stringLength - Public
Ptr stringDomain Name
- network
Tier String - external
Ipv6 String - external
Ipv6Prefix StringLength - public
Ptr StringDomain Name
- network
Tier string - external
Ipv6 string - external
Ipv6Prefix stringLength - public
Ptr stringDomain Name
- network
Tier String - external
Ipv6 String - external
Ipv6Prefix StringLength - public
Ptr StringDomain Name
InstanceFromMachineImageNetworkPerformanceConfig
- Total
Egress stringBandwidth Tier
- Total
Egress stringBandwidth Tier
- total
Egress StringBandwidth Tier
- total
Egress stringBandwidth Tier
- total
Egress StringBandwidth Tier
InstanceFromMachineImageReservationAffinity
InstanceFromMachineImageReservationAffinitySpecificReservation
InstanceFromMachineImageScheduling
- automatic
Restart Boolean - instance
Termination StringAction - maintenance
Interval String - max
Run Property MapDuration - min
Node NumberCpus - node
Affinities List<Property Map> - on
Host StringMaintenance - preemptible Boolean
- provisioning
Model String
InstanceFromMachineImageSchedulingMaxRunDuration
InstanceFromMachineImageSchedulingNodeAffinity
InstanceFromMachineImageScratchDisk
- interface_ String
- size Integer
InstanceFromMachineImageServiceAccount
InstanceFromMachineImageShieldedInstanceConfig
- Enable
Integrity boolMonitoring - Enable
Secure boolBoot - Enable
Vtpm bool
- Enable
Integrity boolMonitoring - Enable
Secure boolBoot - Enable
Vtpm bool
- enable
Integrity BooleanMonitoring - enable
Secure BooleanBoot - enable
Vtpm Boolean
- enable
Integrity booleanMonitoring - enable
Secure booleanBoot - enable
Vtpm boolean
- enable_
integrity_ boolmonitoring - enable_
secure_ boolboot - enable_
vtpm bool
- enable
Integrity BooleanMonitoring - enable
Secure BooleanBoot - enable
Vtpm Boolean
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
google-beta
Terraform Provider.