pulumi-gcp-kotlin/com.pulumi.gcp.compute.kotlin/InstanceFromTemplate

InstanceFromTemplate

class InstanceFromTemplate : KotlinCustomResource

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_instance_template. To create an instance without a template, use the gcp.compute.Instance resource.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.InstanceTemplate;
import com.pulumi.gcp.compute.InstanceTemplateArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateDiskArgs;
import com.pulumi.gcp.compute.inputs.InstanceTemplateNetworkInterfaceArgs;
import com.pulumi.gcp.compute.InstanceFromTemplate;
import com.pulumi.gcp.compute.InstanceFromTemplateArgs;
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 tplInstanceTemplate = new InstanceTemplate("tplInstanceTemplate", InstanceTemplateArgs.builder()
            .machineType("e2-medium")
            .disks(InstanceTemplateDiskArgs.builder()
                .sourceImage("debian-cloud/debian-11")
                .autoDelete(true)
                .diskSizeGb(100)
                .boot(true)
                .build())
            .networkInterfaces(InstanceTemplateNetworkInterfaceArgs.builder()
                .network("default")
                .build())
            .metadata(Map.of("foo", "bar"))
            .canIpForward(true)
            .build());
        var tplInstanceFromTemplate = new InstanceFromTemplate("tplInstanceFromTemplate", InstanceFromTemplateArgs.builder()
            .zone("us-central1-a")
            .sourceInstanceTemplate(tplInstanceTemplate.selfLinkUnique())
            .canIpForward(false)
            .labels(Map.of("my_key", "my_value"))
            .build());
    }
}
Content copied to clipboard

Import

This resource does not support import.

Properties

Link copied to clipboard
val advancedMachineFeatures: Output<InstanceFromTemplateAdvancedMachineFeatures>

Controls for advanced machine-related behavior features.

Link copied to clipboard
val allowStoppingForUpdate: Output<Boolean>

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.

Link copied to clipboard
val attachedDisks: Output<List<InstanceFromTemplateAttachedDisk>>

List of disks attached to the instance

Link copied to clipboard
val bootDisk: Output<InstanceFromTemplateBootDisk>

The boot disk for the instance.

Link copied to clipboard
val canIpForward: Output<Boolean>

Whether sending and receiving of packets with non-matching source or destination IPs is allowed.

Link copied to clipboard
val confidentialInstanceConfig: Output<InstanceFromTemplateConfidentialInstanceConfig>

The Confidential VM config being used by the instance. on_host_maintenance has to be set to TERMINATE or this will fail to create.

Link copied to clipboard
val cpuPlatform: Output<String>

The CPU platform used by this instance.

Link copied to clipboard
val currentStatus: Output<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

Link copied to clipboard
val deletionProtection: Output<Boolean>

Whether deletion protection is enabled on this instance.

Link copied to clipboard
val description: Output<String>

A brief description of the resource.

Link copied to clipboard
val desiredStatus: Output<String>

Desired status of the instance. Either "RUNNING" or "TERMINATED".

Link copied to clipboard
val enableDisplay: Output<Boolean>

Whether the instance has virtual displays enabled.

Link copied to clipboard
val guestAccelerators: Output<List<InstanceFromTemplateGuestAccelerator>>

List of the type and count of accelerator cards attached to the instance.

Link copied to clipboard
val hostname: Output<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-z0-9]*[a-z0-9, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val instanceId: Output<String>

The server-assigned unique identifier of this instance.

Link copied to clipboard
val labelFingerprint: Output<String>

The unique fingerprint of the labels.

Link copied to clipboard
val labels: Output<Map<String, String>>

A set of key/value label pairs assigned to the instance.

Link copied to clipboard
val machineType: Output<String>

The machine type to create.

Link copied to clipboard
val metadata: Output<Map<String, String>>

Metadata key/value pairs made available within the instance.

Link copied to clipboard
val metadataFingerprint: Output<String>

The unique fingerprint of the metadata.

Link copied to clipboard
val metadataStartupScript: Output<String>

Metadata startup scripts made available within the instance.

Link copied to clipboard
val minCpuPlatform: Output<String>

The minimum CPU platform specified for the VM instance.

Link copied to clipboard
val name: Output<String>

A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

Link copied to clipboard
val networkInterfaces: Output<List<InstanceFromTemplateNetworkInterface>>

The networks attached to the instance.

Link copied to clipboard
val networkPerformanceConfig: Output<InstanceFromTemplateNetworkPerformanceConfig>

Configures network performance settings for the instance. If not specified, the instance will be created with its default network performance configuration.

Link copied to clipboard
val params: Output<InstanceFromTemplateParams>

Stores additional params passed with the request, but not persisted as part of resource payload.

Link copied to clipboard
val project: Output<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.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val reservationAffinity: Output<InstanceFromTemplateReservationAffinity>

Specifies the reservations that this instance can consume from.

Link copied to clipboard
val resourcePolicies: Output<String>

A list of self_links of resource policies to attach to the instance. Currently a max of 1 resource policy is supported.

Link copied to clipboard
val scheduling: Output<InstanceFromTemplateScheduling>

The scheduling strategy being used by the instance.

Link copied to clipboard
val scratchDisks: Output<List<InstanceFromTemplateScratchDisk>>

The scratch disks attached to the instance.

Link copied to clipboard
val selfLink: Output<String>

The URI of the created resource.

Link copied to clipboard
val serviceAccount: Output<InstanceFromTemplateServiceAccount>

The service account to attach to the instance.

Link copied to clipboard
val shieldedInstanceConfig: Output<InstanceFromTemplateShieldedInstanceConfig>

The shielded vm config being used by the instance.

Link copied to clipboard
val sourceInstanceTemplate: Output<String>

Name or self link of an instance template to create the instance based on. It is recommended to reference instance templates through their unique id (self_link_unique attribute).

Link copied to clipboard
val tags: Output<List<String>>

The list of tags attached to the instance.

Link copied to clipboard
val tagsFingerprint: Output<String>

The unique fingerprint of the tags.

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val zone: Output<String>

The zone that the machine should be created in. If not set, the provider zone is used. In addition to these, all arguments from gcp.compute.Instance are supported as a way to override the properties in the template. All exported attributes from gcp.compute.Instance are likewise exported here.