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

ImageArgs

data class ImageArgs(val description: Output<String>? = null, val diskSizeGb: Output<Int>? = null, val family: Output<String>? = null, val guestOsFeatures: Output<List<ImageGuestOsFeatureArgs>>? = null, val imageEncryptionKey: Output<ImageImageEncryptionKeyArgs>? = null, val labels: Output<Map<String, String>>? = null, val licenses: Output<List<String>>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val rawDisk: Output<ImageRawDiskArgs>? = null, val shieldedInstanceInitialState: Output<ImageShieldedInstanceInitialStateArgs>? = null, val sourceDisk: Output<String>? = null, val sourceDiskEncryptionKey: Output<ImageSourceDiskEncryptionKeyArgs>? = null, val sourceImage: Output<String>? = null, val sourceImageEncryptionKey: Output<ImageSourceImageEncryptionKeyArgs>? = null, val sourceSnapshot: Output<String>? = null, val sourceSnapshotEncryptionKey: Output<ImageSourceSnapshotEncryptionKeyArgs>? = null, val storageLocations: Output<List<String>>? = null) : ConvertibleToJava<ImageArgs>

Represents an Image resource. Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine. Images can be either public or custom. Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance. To get more information about Image, see:

Example Usage

Image Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debian = gcp.compute.getImage({
    family: "debian-12",
    project: "debian-cloud",
});
const persistent = new gcp.compute.Disk("persistent", {
    name: "example-disk",
    image: debian.then(debian => debian.selfLink),
    size: 10,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const example = new gcp.compute.Image("example", {
    name: "example-image",
    sourceDisk: persistent.id,
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
debian = gcp.compute.get_image(family="debian-12",
    project="debian-cloud")
persistent = gcp.compute.Disk("persistent",
    name="example-disk",
    image=debian.self_link,
    size=10,
    type="pd-ssd",
    zone="us-central1-a")
example = gcp.compute.Image("example",
    name="example-image",
    source_disk=persistent.id)
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var debian = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-12",
        Project = "debian-cloud",
    });
    var persistent = new Gcp.Compute.Disk("persistent", new()
    {
        Name = "example-disk",
        Image = debian.Apply(getImageResult => getImageResult.SelfLink),
        Size = 10,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var example = new Gcp.Compute.Image("example", new()
    {
        Name = "example-image",
        SourceDisk = persistent.Id,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		debian, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-12"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		persistent, err := compute.NewDisk(ctx, "persistent", &compute.DiskArgs{
			Name:  pulumi.String("example-disk"),
			Image: pulumi.String(debian.SelfLink),
			Size:  pulumi.Int(10),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewImage(ctx, "example", &compute.ImageArgs{
			Name:       pulumi.String("example-image"),
			SourceDisk: persistent.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.Image;
import com.pulumi.gcp.compute.ImageArgs;
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) {
        final var debian = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-12")
            .project("debian-cloud")
            .build());
        var persistent = new Disk("persistent", DiskArgs.builder()
            .name("example-disk")
            .image(debian.selfLink())
            .size(10)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var example = new Image("example", ImageArgs.builder()
            .name("example-image")
            .sourceDisk(persistent.id())
            .build());
    }
}
Content copied to clipboard
resources:
  persistent:
    type: gcp:compute:Disk
    properties:
      name: example-disk
      image: ${debian.selfLink}
      size: 10
      type: pd-ssd
      zone: us-central1-a
  example:
    type: gcp:compute:Image
    properties:
      name: example-image
      sourceDisk: ${persistent.id}
variables:
  debian:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-12
        project: debian-cloud
Content copied to clipboard

Image Guest Os

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debian = gcp.compute.getImage({
    family: "debian-12",
    project: "debian-cloud",
});
const persistent = new gcp.compute.Disk("persistent", {
    name: "example-disk",
    image: debian.then(debian => debian.selfLink),
    size: 10,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const example = new gcp.compute.Image("example", {
    name: "example-image",
    sourceDisk: persistent.id,
    guestOsFeatures: [
        {
            type: "UEFI_COMPATIBLE",
        },
        {
            type: "VIRTIO_SCSI_MULTIQUEUE",
        },
        {
            type: "GVNIC",
        },
        {
            type: "SEV_CAPABLE",
        },
        {
            type: "SEV_LIVE_MIGRATABLE_V2",
        },
    ],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
debian = gcp.compute.get_image(family="debian-12",
    project="debian-cloud")
persistent = gcp.compute.Disk("persistent",
    name="example-disk",
    image=debian.self_link,
    size=10,
    type="pd-ssd",
    zone="us-central1-a")
example = gcp.compute.Image("example",
    name="example-image",
    source_disk=persistent.id,
    guest_os_features=[
        {
            "type": "UEFI_COMPATIBLE",
        },
        {
            "type": "VIRTIO_SCSI_MULTIQUEUE",
        },
        {
            "type": "GVNIC",
        },
        {
            "type": "SEV_CAPABLE",
        },
        {
            "type": "SEV_LIVE_MIGRATABLE_V2",
        },
    ])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var debian = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-12",
        Project = "debian-cloud",
    });
    var persistent = new Gcp.Compute.Disk("persistent", new()
    {
        Name = "example-disk",
        Image = debian.Apply(getImageResult => getImageResult.SelfLink),
        Size = 10,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var example = new Gcp.Compute.Image("example", new()
    {
        Name = "example-image",
        SourceDisk = persistent.Id,
        GuestOsFeatures = new[]
        {
            new Gcp.Compute.Inputs.ImageGuestOsFeatureArgs
            {
                Type = "UEFI_COMPATIBLE",
            },
            new Gcp.Compute.Inputs.ImageGuestOsFeatureArgs
            {
                Type = "VIRTIO_SCSI_MULTIQUEUE",
            },
            new Gcp.Compute.Inputs.ImageGuestOsFeatureArgs
            {
                Type = "GVNIC",
            },
            new Gcp.Compute.Inputs.ImageGuestOsFeatureArgs
            {
                Type = "SEV_CAPABLE",
            },
            new Gcp.Compute.Inputs.ImageGuestOsFeatureArgs
            {
                Type = "SEV_LIVE_MIGRATABLE_V2",
            },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		debian, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-12"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		persistent, err := compute.NewDisk(ctx, "persistent", &compute.DiskArgs{
			Name:  pulumi.String("example-disk"),
			Image: pulumi.String(debian.SelfLink),
			Size:  pulumi.Int(10),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewImage(ctx, "example", &compute.ImageArgs{
			Name:       pulumi.String("example-image"),
			SourceDisk: persistent.ID(),
			GuestOsFeatures: compute.ImageGuestOsFeatureArray{
				&compute.ImageGuestOsFeatureArgs{
					Type: pulumi.String("UEFI_COMPATIBLE"),
				},
				&compute.ImageGuestOsFeatureArgs{
					Type: pulumi.String("VIRTIO_SCSI_MULTIQUEUE"),
				},
				&compute.ImageGuestOsFeatureArgs{
					Type: pulumi.String("GVNIC"),
				},
				&compute.ImageGuestOsFeatureArgs{
					Type: pulumi.String("SEV_CAPABLE"),
				},
				&compute.ImageGuestOsFeatureArgs{
					Type: pulumi.String("SEV_LIVE_MIGRATABLE_V2"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.Image;
import com.pulumi.gcp.compute.ImageArgs;
import com.pulumi.gcp.compute.inputs.ImageGuestOsFeatureArgs;
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) {
        final var debian = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-12")
            .project("debian-cloud")
            .build());
        var persistent = new Disk("persistent", DiskArgs.builder()
            .name("example-disk")
            .image(debian.selfLink())
            .size(10)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var example = new Image("example", ImageArgs.builder()
            .name("example-image")
            .sourceDisk(persistent.id())
            .guestOsFeatures(
                ImageGuestOsFeatureArgs.builder()
                    .type("UEFI_COMPATIBLE")
                    .build(),
                ImageGuestOsFeatureArgs.builder()
                    .type("VIRTIO_SCSI_MULTIQUEUE")
                    .build(),
                ImageGuestOsFeatureArgs.builder()
                    .type("GVNIC")
                    .build(),
                ImageGuestOsFeatureArgs.builder()
                    .type("SEV_CAPABLE")
                    .build(),
                ImageGuestOsFeatureArgs.builder()
                    .type("SEV_LIVE_MIGRATABLE_V2")
                    .build())
            .build());
    }
}
Content copied to clipboard
resources:
  persistent:
    type: gcp:compute:Disk
    properties:
      name: example-disk
      image: ${debian.selfLink}
      size: 10
      type: pd-ssd
      zone: us-central1-a
  example:
    type: gcp:compute:Image
    properties:
      name: example-image
      sourceDisk: ${persistent.id}
      guestOsFeatures:
        - type: UEFI_COMPATIBLE
        - type: VIRTIO_SCSI_MULTIQUEUE
        - type: GVNIC
        - type: SEV_CAPABLE
        - type: SEV_LIVE_MIGRATABLE_V2
variables:
  debian:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-12
        project: debian-cloud
Content copied to clipboard

Image Basic Storage Location

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const debian = gcp.compute.getImage({
    family: "debian-12",
    project: "debian-cloud",
});
const persistent = new gcp.compute.Disk("persistent", {
    name: "example-disk",
    image: debian.then(debian => debian.selfLink),
    size: 10,
    type: "pd-ssd",
    zone: "us-central1-a",
});
const example = new gcp.compute.Image("example", {
    name: "example-sl-image",
    sourceDisk: persistent.id,
    storageLocations: ["us-central1"],
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
debian = gcp.compute.get_image(family="debian-12",
    project="debian-cloud")
persistent = gcp.compute.Disk("persistent",
    name="example-disk",
    image=debian.self_link,
    size=10,
    type="pd-ssd",
    zone="us-central1-a")
example = gcp.compute.Image("example",
    name="example-sl-image",
    source_disk=persistent.id,
    storage_locations=["us-central1"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var debian = Gcp.Compute.GetImage.Invoke(new()
    {
        Family = "debian-12",
        Project = "debian-cloud",
    });
    var persistent = new Gcp.Compute.Disk("persistent", new()
    {
        Name = "example-disk",
        Image = debian.Apply(getImageResult => getImageResult.SelfLink),
        Size = 10,
        Type = "pd-ssd",
        Zone = "us-central1-a",
    });
    var example = new Gcp.Compute.Image("example", new()
    {
        Name = "example-sl-image",
        SourceDisk = persistent.Id,
        StorageLocations = new[]
        {
            "us-central1",
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		debian, err := compute.LookupImage(ctx, &compute.LookupImageArgs{
			Family:  pulumi.StringRef("debian-12"),
			Project: pulumi.StringRef("debian-cloud"),
		}, nil)
		if err != nil {
			return err
		}
		persistent, err := compute.NewDisk(ctx, "persistent", &compute.DiskArgs{
			Name:  pulumi.String("example-disk"),
			Image: pulumi.String(debian.SelfLink),
			Size:  pulumi.Int(10),
			Type:  pulumi.String("pd-ssd"),
			Zone:  pulumi.String("us-central1-a"),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewImage(ctx, "example", &compute.ImageArgs{
			Name:       pulumi.String("example-sl-image"),
			SourceDisk: persistent.ID(),
			StorageLocations: pulumi.StringArray{
				pulumi.String("us-central1"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.ComputeFunctions;
import com.pulumi.gcp.compute.inputs.GetImageArgs;
import com.pulumi.gcp.compute.Disk;
import com.pulumi.gcp.compute.DiskArgs;
import com.pulumi.gcp.compute.Image;
import com.pulumi.gcp.compute.ImageArgs;
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) {
        final var debian = ComputeFunctions.getImage(GetImageArgs.builder()
            .family("debian-12")
            .project("debian-cloud")
            .build());
        var persistent = new Disk("persistent", DiskArgs.builder()
            .name("example-disk")
            .image(debian.selfLink())
            .size(10)
            .type("pd-ssd")
            .zone("us-central1-a")
            .build());
        var example = new Image("example", ImageArgs.builder()
            .name("example-sl-image")
            .sourceDisk(persistent.id())
            .storageLocations("us-central1")
            .build());
    }
}
Content copied to clipboard
resources:
  persistent:
    type: gcp:compute:Disk
    properties:
      name: example-disk
      image: ${debian.selfLink}
      size: 10
      type: pd-ssd
      zone: us-central1-a
  example:
    type: gcp:compute:Image
    properties:
      name: example-sl-image
      sourceDisk: ${persistent.id}
      storageLocations:
        - us-central1
variables:
  debian:
    fn::invoke:
      function: gcp:compute:getImage
      arguments:
        family: debian-12
        project: debian-cloud
Content copied to clipboard

Import

Image can be imported using any of these accepted formats:

  • projects/{{project}}/global/images/{{name}}

  • {{project}}/{{name}}

  • {{name}} When using the pulumi import command, Image can be imported using one of the formats above. For example:

$ pulumi import gcp:compute/image:Image default projects/{{project}}/global/images/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/image:Image default {{project}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:compute/image:Image default {{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, diskSizeGb: Output<Int>? = null, family: Output<String>? = null, guestOsFeatures: Output<List<ImageGuestOsFeatureArgs>>? = null, imageEncryptionKey: Output<ImageImageEncryptionKeyArgs>? = null, labels: Output<Map<String, String>>? = null, licenses: Output<List<String>>? = null, name: Output<String>? = null, project: Output<String>? = null, rawDisk: Output<ImageRawDiskArgs>? = null, shieldedInstanceInitialState: Output<ImageShieldedInstanceInitialStateArgs>? = null, sourceDisk: Output<String>? = null, sourceDiskEncryptionKey: Output<ImageSourceDiskEncryptionKeyArgs>? = null, sourceImage: Output<String>? = null, sourceImageEncryptionKey: Output<ImageSourceImageEncryptionKeyArgs>? = null, sourceSnapshot: Output<String>? = null, sourceSnapshotEncryptionKey: Output<ImageSourceSnapshotEncryptionKeyArgs>? = null, storageLocations: Output<List<String>>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

An optional description of this resource. Provide this property when you create the resource.

Link copied to clipboard
val diskSizeGb: Output<Int>? = null

Size of the image when restored onto a persistent disk (in GB).

Link copied to clipboard
val family: Output<String>? = null

The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035.

Link copied to clipboard
val guestOsFeatures: Output<List<ImageGuestOsFeatureArgs>>? = null

A list of features to enable on the guest operating system. Applicable only for bootable images. Structure is documented below.

Link copied to clipboard
val imageEncryptionKey: Output<ImageImageEncryptionKeyArgs>? = null

Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image) Structure is documented below.

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

Labels to apply to this Image. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Link copied to clipboard
val licenses: Output<List<String>>? = null

Any applicable license URI.

Link copied to clipboard
val name: Output<String>? = null

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Link copied to clipboard
val project: Output<String>? = null

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val rawDisk: Output<ImageRawDiskArgs>? = null

The parameters of the raw disk image. Structure is documented below.

Link copied to clipboard
val shieldedInstanceInitialState: Output<ImageShieldedInstanceInitialStateArgs>? = null

Set the secure boot keys of shielded instance. Structure is documented below.

Link copied to clipboard
val sourceDisk: Output<String>? = null

The source disk to create this image based on. You must provide either this property or the rawDisk.source property but not both to create an image.

Link copied to clipboard
val sourceDiskEncryptionKey: Output<ImageSourceDiskEncryptionKeyArgs>? = null

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. Structure is documented below.

Link copied to clipboard
val sourceImage: Output<String>? = null

URL of the source image used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:

Link copied to clipboard
val sourceImageEncryptionKey: Output<ImageSourceImageEncryptionKeyArgs>? = null

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Structure is documented below.

Link copied to clipboard
val sourceSnapshot: Output<String>? = null

URL of the source snapshot used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:

Link copied to clipboard
val sourceSnapshotEncryptionKey: Output<ImageSourceSnapshotEncryptionKeyArgs>? = null

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Structure is documented below.

Link copied to clipboard
val storageLocations: Output<List<String>>? = null

Cloud Storage bucket storage location of the image (regional or multi-regional). Reference link: https://cloud.google.com/compute/docs/reference/rest/v1/images

Functions

Link copied to clipboard
open override fun toJava(): ImageArgs