
com.pulumi.gcp.compute.kotlin.Image.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.gcp.compute.kotlin
import com.pulumi.core.Output
import com.pulumi.gcp.compute.kotlin.outputs.ImageGuestOsFeature
import com.pulumi.gcp.compute.kotlin.outputs.ImageImageEncryptionKey
import com.pulumi.gcp.compute.kotlin.outputs.ImageRawDisk
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import com.pulumi.gcp.compute.kotlin.outputs.ImageGuestOsFeature.Companion.toKotlin as imageGuestOsFeatureToKotlin
import com.pulumi.gcp.compute.kotlin.outputs.ImageImageEncryptionKey.Companion.toKotlin as imageImageEncryptionKeyToKotlin
import com.pulumi.gcp.compute.kotlin.outputs.ImageRawDisk.Companion.toKotlin as imageRawDiskToKotlin
/**
* Builder for [Image].
*/
@PulumiTagMarker
public class ImageResourceBuilder internal constructor() {
public var name: String? = null
public var args: ImageArgs = ImageArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend ImageArgsBuilder.() -> Unit) {
val builder = ImageArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): Image {
val builtJavaResource = com.pulumi.gcp.compute.Image(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Image(builtJavaResource)
}
}
/**
* 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:
* * [API documentation](https://cloud.google.com/compute/docs/reference/v1/images)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/compute/docs/images)
* ## Example Usage
* ### Image Basic
*
* ```typescript
* 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,
* });
* ```
* ```python
* 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)
* ```
* ```csharp
* 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,
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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.applyValue(getImageResult -> getImageResult.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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ### Image Guest Os
*
* ```typescript
* 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",
* },
* ],
* });
* ```
* ```python
* 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",
* },
* ])
* ```
* ```csharp
* 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",
* },
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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.applyValue(getImageResult -> getImageResult.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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ### Image Basic Storage Location
*
* ```typescript
* 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"],
* });
* ```
* ```python
* 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"])
* ```
* ```csharp
* 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",
* },
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```java
* 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.applyValue(getImageResult -> getImageResult.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());
* }
* }
* ```
* ```yaml
* 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
* ```
*
* ## 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:
* ```sh
* $ pulumi import gcp:compute/image:Image default projects/{{project}}/global/images/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/image:Image default {{project}}/{{name}}
* ```
* ```sh
* $ pulumi import gcp:compute/image:Image default {{name}}
* ```
*/
public class Image internal constructor(
override val javaResource: com.pulumi.gcp.compute.Image,
) : KotlinCustomResource(javaResource, ImageMapper) {
/**
* Size of the image tar.gz archive stored in Google Cloud Storage (in
* bytes).
*/
public val archiveSizeBytes: Output
get() = javaResource.archiveSizeBytes().applyValue({ args0 -> args0 })
/**
* Creation timestamp in RFC3339 text format.
*/
public val creationTimestamp: Output
get() = javaResource.creationTimestamp().applyValue({ args0 -> args0 })
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
public val description: Output?
get() = javaResource.description().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Size of the image when restored onto a persistent disk (in GB).
*/
public val diskSizeGb: Output
get() = javaResource.diskSizeGb().applyValue({ args0 -> args0 })
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
public val effectiveLabels: Output
© 2015 - 2025 Weber Informatics LLC | Privacy Policy