Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. OVH
  4. API Docs
  5. getCloudInstanceImage
Viewing docs for OVHCloud v2.19.1
published on Tuesday, Aug 18, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.getCloudInstanceImage

ovh logo
Viewing docs for OVHCloud v2.19.1
published on Tuesday, Aug 18, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Use this data source to retrieve information about an image available in a public cloud project. This is read-only reference data: it describes a bootable image the project can create instances from, not an existing resource.

    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?: InvokeOutputOptions): Output<GetCloudInstanceImageResult>
    def get_cloud_instance_image(id: Optional[str] = None,
                             service_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCloudInstanceImageResult
def get_cloud_instance_image_output(id: pulumi.Input[Optional[str]] = None,
                             service_name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudInstanceImageResult]
    func GetCloudInstanceImage(ctx *Context, args *GetCloudInstanceImageArgs, opts ...InvokeOption) (*GetCloudInstanceImageResult, error)
func GetCloudInstanceImageOutput(ctx *Context, args *GetCloudInstanceImageOutputArgs, opts ...InvokeOption) GetCloudInstanceImageResultOutput

    > Note: This function is named GetCloudInstanceImage 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 Output<GetCloudInstanceImageResult> Invoke(GetCloudInstanceImageInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudInstanceImageResult> getCloudInstanceImage(GetCloudInstanceImageArgs args, InvokeOptions options)
public static Output<GetCloudInstanceImageResult> getCloudInstanceImage(GetCloudInstanceImageArgs args, InvokeOptions options)
public static Output<GetCloudInstanceImageResult> getCloudInstanceImage(GetCloudInstanceImageArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ovh:index/getCloudInstanceImage:getCloudInstanceImage
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_instance_image" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    ServiceName string
    Service name of the resource representing the id of the cloud project.
    Id string
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    ServiceName string
    Service name of the resource representing the id of the cloud project.
    id string
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    service_name string
    Service name of the resource representing the id of the cloud project.
    id String
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    serviceName String
    Service name of the resource representing the id of the cloud project.
    id string
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    serviceName string
    Service name of the resource representing the id of the cloud project.
    id str
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    service_name str
    Service name of the resource representing the id of the cloud project.
    id String
    The OpenStack/Glance image ID to look up. Stable within a region and used to reference the image when creating an instance.
    serviceName String
    Service name of the resource representing the id of the cloud project.

    getCloudInstanceImage Result

    The following output properties are available:

    CreatedAt string
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    Id string
    Location GetCloudInstanceImageLocation
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    MinDisk int
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    MinRam int
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    Name string
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    ServiceName string
    Size int
    Size of the image on the backend, expressed in bytes.
    Status string
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    UpdatedAt string
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    Visibility string
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    CreatedAt string
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    Id string
    Location GetCloudInstanceImageLocation
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    MinDisk int
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    MinRam int
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    Name string
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    ServiceName string
    Size int
    Size of the image on the backend, expressed in bytes.
    Status string
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    UpdatedAt string
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    Visibility string
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    created_at string
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    id string
    location object
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    min_disk number
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    min_ram number
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    name string
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    service_name string
    size number
    Size of the image on the backend, expressed in bytes.
    status string
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    updated_at string
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    visibility string
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    createdAt String
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    id String
    location GetCloudInstanceImageLocation
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    minDisk Integer
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    minRam Integer
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    name String
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    serviceName String
    size Integer
    Size of the image on the backend, expressed in bytes.
    status String
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    updatedAt String
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    visibility String
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    createdAt string
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    id string
    location GetCloudInstanceImageLocation
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    minDisk number
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    minRam number
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    name string
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    serviceName string
    size number
    Size of the image on the backend, expressed in bytes.
    status string
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    updatedAt string
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    visibility string
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    created_at str
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    id str
    location GetCloudInstanceImageLocation
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    min_disk int
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    min_ram int
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    name str
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    service_name str
    size int
    Size of the image on the backend, expressed in bytes.
    status str
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    updated_at str
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    visibility str
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.
    createdAt String
    Timestamp at which the image was created on the backend, in RFC 3339 format.
    id String
    location Property Map
    Region (and, where applicable, availability zone) where this image is offered. The image catalog is per-region: an image returned for one region is not guaranteed to exist in another:
    minDisk Number
    Minimum root disk size, in GB, that an instance must provide to boot from this image. A flavor whose disk is smaller than this value cannot be used with the image.
    minRam Number
    Minimum amount of memory, in MB, that an instance must provide to boot from this image. A flavor whose RAM is below this value cannot be used with the image.
    name String
    Display name of the image as reported by the backend (for example the distribution and version, such as Debian 12).
    serviceName String
    size Number
    Size of the image on the backend, expressed in bytes.
    status String
    Availability status of the image as reported by the backend. Only images in an active status can be used to create an instance.
    updatedAt String
    Timestamp of the last modification of the image on the backend, in RFC 3339 format.
    visibility String
    Visibility scope of the image, for example whether it is a public OVHcloud-provided image or private to the project.

    Supporting Types

    GetCloudInstanceImageLocation

    AvailabilityZone string
    Availability zone within the region.
    Region string
    Region code.
    AvailabilityZone string
    Availability zone within the region.
    Region string
    Region code.
    availability_zone string
    Availability zone within the region.
    region string
    Region code.
    availabilityZone String
    Availability zone within the region.
    region String
    Region code.
    availabilityZone string
    Availability zone within the region.
    region string
    Region code.
    availability_zone str
    Availability zone within the region.
    region str
    Region code.
    availabilityZone String
    Availability zone within the region.
    region String
    Region code.

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.19.1
    published on Tuesday, Aug 18, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial