1. Packages
  2. Gcore Provider
  3. API Docs
  4. getCloudInstanceImage
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core
gcore logo
Viewing docs for gcore 2.0.0-alpha.2
published on Tuesday, Mar 24, 2026 by g-core

    Instance images are operating system images (public, private, or shared) used to boot cloud instances.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as gcore from "@pulumi/gcore";
    
    const exampleCloudInstanceImage = gcore.getCloudInstanceImage({
        projectId: 0,
        regionId: 0,
        imageId: "image_id",
        includePrices: true,
    });
    
    import pulumi
    import pulumi_gcore as gcore
    
    example_cloud_instance_image = gcore.get_cloud_instance_image(project_id=0,
        region_id=0,
        image_id="image_id",
        include_prices=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/gcore/v2/gcore"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := gcore.LookupCloudInstanceImage(ctx, &gcore.LookupCloudInstanceImageArgs{
    			ProjectId:     pulumi.Float64Ref(0),
    			RegionId:      pulumi.Float64Ref(0),
    			ImageId:       "image_id",
    			IncludePrices: pulumi.BoolRef(true),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Gcore = Pulumi.Gcore;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleCloudInstanceImage = Gcore.GetCloudInstanceImage.Invoke(new()
        {
            ProjectId = 0,
            RegionId = 0,
            ImageId = "image_id",
            IncludePrices = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcore.GcoreFunctions;
    import com.pulumi.gcore.inputs.GetCloudInstanceImageArgs;
    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 exampleCloudInstanceImage = GcoreFunctions.getCloudInstanceImage(GetCloudInstanceImageArgs.builder()
                .projectId(0)
                .regionId(0)
                .imageId("image_id")
                .includePrices(true)
                .build());
    
        }
    }
    
    variables:
      exampleCloudInstanceImage:
        fn::invoke:
          function: gcore:getCloudInstanceImage
          arguments:
            projectId: 0
            regionId: 0
            imageId: image_id
            includePrices: true
    

    Using getCloudInstanceImage

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudInstanceImage(args: GetCloudInstanceImageArgs, opts?: InvokeOptions): Promise<GetCloudInstanceImageResult>
    function getCloudInstanceImageOutput(args: GetCloudInstanceImageOutputArgs, opts?: InvokeOptions): Output<GetCloudInstanceImageResult>
    def get_cloud_instance_image(image_id: Optional[str] = None,
                                 include_prices: Optional[bool] = None,
                                 project_id: Optional[float] = None,
                                 region_id: Optional[float] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetCloudInstanceImageResult
    def get_cloud_instance_image_output(image_id: Optional[pulumi.Input[str]] = None,
                                 include_prices: Optional[pulumi.Input[bool]] = None,
                                 project_id: Optional[pulumi.Input[float]] = None,
                                 region_id: Optional[pulumi.Input[float]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetCloudInstanceImageResult]
    func LookupCloudInstanceImage(ctx *Context, args *LookupCloudInstanceImageArgs, opts ...InvokeOption) (*LookupCloudInstanceImageResult, error)
    func LookupCloudInstanceImageOutput(ctx *Context, args *LookupCloudInstanceImageOutputArgs, opts ...InvokeOption) LookupCloudInstanceImageResultOutput

    > Note: This function is named LookupCloudInstanceImage in the Go SDK.

    public static class GetCloudInstanceImage 
    {
        public static Task<GetCloudInstanceImageResult> InvokeAsync(GetCloudInstanceImageArgs args, InvokeOptions? opts = null)
        public static Output<GetCloudInstanceImageResult> Invoke(GetCloudInstanceImageInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCloudInstanceImageResult> getCloudInstanceImage(GetCloudInstanceImageArgs args, InvokeOptions options)
    public static Output<GetCloudInstanceImageResult> getCloudInstanceImage(GetCloudInstanceImageArgs args, InvokeOptions options)
    
    fn::invoke:
      function: gcore:index/getCloudInstanceImage:getCloudInstanceImage
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ImageId string
    IncludePrices bool
    Show price
    ProjectId double
    RegionId double
    ImageId string
    IncludePrices bool
    Show price
    ProjectId float64
    RegionId float64
    imageId String
    includePrices Boolean
    Show price
    projectId Double
    regionId Double
    imageId string
    includePrices boolean
    Show price
    projectId number
    regionId number
    image_id str
    include_prices bool
    Show price
    project_id float
    region_id float
    imageId String
    includePrices Boolean
    Show price
    projectId Number
    regionId Number

    getCloudInstanceImage Result

    The following output properties are available:

    Architecture string
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    CreatedAt string
    Datetime when the image was created
    CreatorTaskId string
    Task that created this entity
    Description string
    Image description
    DiskFormat string
    Disk format
    DisplayOrder double
    GpuDriver string
    Name of the GPU driver vendor
    GpuDriverType string
    Type of the GPU driver
    GpuDriverVersion string
    Version of the installed GPU driver
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    HwMachineType string
    A virtual chipset type. Available values: "pc", "q35".
    Id string
    The ID of this resource.
    ImageId string
    IsBaremetal bool
    Set to true if the image will be used by bare metal servers. Defaults to false.
    MinDisk double
    Minimal boot volume required
    MinRam double
    Minimal VM RAM required
    Name string
    Image display name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    OsType string
    The operating system installed on the image. Available values: "linux", "windows".
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    Region string
    Region name
    Size double
    Image size in bytes
    SshKey string
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    Status string
    Image status, i.e. active
    Tags List<GetCloudInstanceImageTag>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    UpdatedAt string
    Datetime when the image was updated
    Visibility string
    Image visibility. Globally visible images are public
    IncludePrices bool
    Show price
    ProjectId double
    RegionId double
    Architecture string
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    CreatedAt string
    Datetime when the image was created
    CreatorTaskId string
    Task that created this entity
    Description string
    Image description
    DiskFormat string
    Disk format
    DisplayOrder float64
    GpuDriver string
    Name of the GPU driver vendor
    GpuDriverType string
    Type of the GPU driver
    GpuDriverVersion string
    Version of the installed GPU driver
    HwFirmwareType string
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    HwMachineType string
    A virtual chipset type. Available values: "pc", "q35".
    Id string
    The ID of this resource.
    ImageId string
    IsBaremetal bool
    Set to true if the image will be used by bare metal servers. Defaults to false.
    MinDisk float64
    Minimal boot volume required
    MinRam float64
    Minimal VM RAM required
    Name string
    Image display name
    OsDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    OsType string
    The operating system installed on the image. Available values: "linux", "windows".
    OsVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    Region string
    Region name
    Size float64
    Image size in bytes
    SshKey string
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    Status string
    Image status, i.e. active
    Tags []GetCloudInstanceImageTag
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    UpdatedAt string
    Datetime when the image was updated
    Visibility string
    Image visibility. Globally visible images are public
    IncludePrices bool
    Show price
    ProjectId float64
    RegionId float64
    architecture String
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    createdAt String
    Datetime when the image was created
    creatorTaskId String
    Task that created this entity
    description String
    Image description
    diskFormat String
    Disk format
    displayOrder Double
    gpuDriver String
    Name of the GPU driver vendor
    gpuDriverType String
    Type of the GPU driver
    gpuDriverVersion String
    Version of the installed GPU driver
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    hwMachineType String
    A virtual chipset type. Available values: "pc", "q35".
    id String
    The ID of this resource.
    imageId String
    isBaremetal Boolean
    Set to true if the image will be used by bare metal servers. Defaults to false.
    minDisk Double
    Minimal boot volume required
    minRam Double
    Minimal VM RAM required
    name String
    Image display name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    osType String
    The operating system installed on the image. Available values: "linux", "windows".
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    region String
    Region name
    size Double
    Image size in bytes
    sshKey String
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    status String
    Image status, i.e. active
    tags List<GetCloudInstanceImageTag>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    updatedAt String
    Datetime when the image was updated
    visibility String
    Image visibility. Globally visible images are public
    includePrices Boolean
    Show price
    projectId Double
    regionId Double
    architecture string
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    createdAt string
    Datetime when the image was created
    creatorTaskId string
    Task that created this entity
    description string
    Image description
    diskFormat string
    Disk format
    displayOrder number
    gpuDriver string
    Name of the GPU driver vendor
    gpuDriverType string
    Type of the GPU driver
    gpuDriverVersion string
    Version of the installed GPU driver
    hwFirmwareType string
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    hwMachineType string
    A virtual chipset type. Available values: "pc", "q35".
    id string
    The ID of this resource.
    imageId string
    isBaremetal boolean
    Set to true if the image will be used by bare metal servers. Defaults to false.
    minDisk number
    Minimal boot volume required
    minRam number
    Minimal VM RAM required
    name string
    Image display name
    osDistro string
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    osType string
    The operating system installed on the image. Available values: "linux", "windows".
    osVersion string
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    region string
    Region name
    size number
    Image size in bytes
    sshKey string
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    status string
    Image status, i.e. active
    tags GetCloudInstanceImageTag[]
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    updatedAt string
    Datetime when the image was updated
    visibility string
    Image visibility. Globally visible images are public
    includePrices boolean
    Show price
    projectId number
    regionId number
    architecture str
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    created_at str
    Datetime when the image was created
    creator_task_id str
    Task that created this entity
    description str
    Image description
    disk_format str
    Disk format
    display_order float
    gpu_driver str
    Name of the GPU driver vendor
    gpu_driver_type str
    Type of the GPU driver
    gpu_driver_version str
    Version of the installed GPU driver
    hw_firmware_type str
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    hw_machine_type str
    A virtual chipset type. Available values: "pc", "q35".
    id str
    The ID of this resource.
    image_id str
    is_baremetal bool
    Set to true if the image will be used by bare metal servers. Defaults to false.
    min_disk float
    Minimal boot volume required
    min_ram float
    Minimal VM RAM required
    name str
    Image display name
    os_distro str
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    os_type str
    The operating system installed on the image. Available values: "linux", "windows".
    os_version str
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    region str
    Region name
    size float
    Image size in bytes
    ssh_key str
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    status str
    Image status, i.e. active
    tags Sequence[GetCloudInstanceImageTag]
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    updated_at str
    Datetime when the image was updated
    visibility str
    Image visibility. Globally visible images are public
    include_prices bool
    Show price
    project_id float
    region_id float
    architecture String
    An image architecture type: aarch64, x86_64 Available values: "aarch64", <span pulumi-lang-nodejs=""x8664"" pulumi-lang-dotnet=""X8664"" pulumi-lang-go=""x8664"" pulumi-lang-python=""x86_64"" pulumi-lang-yaml=""x8664"" pulumi-lang-java=""x8664"">"x86_64".
    createdAt String
    Datetime when the image was created
    creatorTaskId String
    Task that created this entity
    description String
    Image description
    diskFormat String
    Disk format
    displayOrder Number
    gpuDriver String
    Name of the GPU driver vendor
    gpuDriverType String
    Type of the GPU driver
    gpuDriverVersion String
    Version of the installed GPU driver
    hwFirmwareType String
    Specifies the type of firmware with which to boot the guest. Available values: "bios", "uefi".
    hwMachineType String
    A virtual chipset type. Available values: "pc", "q35".
    id String
    The ID of this resource.
    imageId String
    isBaremetal Boolean
    Set to true if the image will be used by bare metal servers. Defaults to false.
    minDisk Number
    Minimal boot volume required
    minRam Number
    Minimal VM RAM required
    name String
    Image display name
    osDistro String
    OS Distribution, i.e. Debian, CentOS, Ubuntu, CoreOS etc.
    osType String
    The operating system installed on the image. Available values: "linux", "windows".
    osVersion String
    OS version, i.e. 19.04 (for Ubuntu) or 9.4 for Debian
    region String
    Region name
    size Number
    Image size in bytes
    sshKey String
    Whether the image supports SSH key or not Available values: "allow", "deny", "required".
    status String
    Image status, i.e. active
    tags List<Property Map>
    List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.
    updatedAt String
    Datetime when the image was updated
    visibility String
    Image visibility. Globally visible images are public
    includePrices Boolean
    Show price
    projectId Number
    regionId Number

    Supporting Types

    GetCloudInstanceImageTag

    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    Key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    ReadOnly bool
    If true, the tag is read-only and cannot be modified by the user
    Value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key string
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly boolean
    If true, the tag is read-only and cannot be modified by the user
    value string
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key str
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    read_only bool
    If true, the tag is read-only and cannot be modified by the user
    value str
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    key String
    Tag key. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.
    readOnly Boolean
    If true, the tag is read-only and cannot be modified by the user
    value String
    Tag value. Maximum 255 characters. Cannot contain spaces, tabs, newlines, empty string or '=' character.

    Package Details

    Repository
    gcore g-core/terraform-provider-gcore
    License
    Notes
    This Pulumi package is based on the gcore Terraform Provider.
    gcore logo
    Viewing docs for gcore 2.0.0-alpha.2
    published on Tuesday, Mar 24, 2026 by g-core
      Try Pulumi Cloud free. Your team will thank you.