GetImages

Get information on images for use in other resources (e.g. creating a Droplet based on a snapshot), with the ability to filter and sort the results. If no filters are specified, all images will be returned.

This data source is useful if the image in question is not managed by this provider or you need to utilize any of the image’s data.

Note: You can use the digitalocean..getImage data source to obtain metadata about a single image if you already know the slug, unique name, or id to retrieve.

Example Usage

using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

class MyStack : Stack
{
    public MyStack()
    {
        var ubuntu = Output.Create(DigitalOcean.GetImages.InvokeAsync(new DigitalOcean.GetImagesArgs
        {
            Filters = 
            {
                new DigitalOcean.Inputs.GetImagesFilterArgs
                {
                    Key = "distribution",
                    Values = 
                    {
                        "Ubuntu",
                    },
                },
            },
        }));
    }

}

Coming soon!

import pulumi
import pulumi_digitalocean as digitalocean

ubuntu = digitalocean.get_images(filters=[{
    "key": "distribution",
    "values": ["Ubuntu"],
}])

import * as pulumi from "@pulumi/pulumi";
import * as digitalocean from "@pulumi/digitalocean";

const ubuntu = pulumi.output(digitalocean.getImages({
    filters: [{
        key: "distribution",
        values: ["Ubuntu"],
    }],
}, { async: true }));

Using GetImages

function getImages(args: GetImagesArgs, opts?: InvokeOptions): Promise<GetImagesResult>

function  get_images(filters=None, sorts=None, opts=None)

func GetImages(ctx *Context, args *GetImagesArgs, opts ...InvokeOption) (*GetImagesResult, error)

public static class GetImages {
    public static Task<GetImagesResult> InvokeAsync(GetImagesArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<Pulumi.DigitalOcean.Inputs.GetImagesFilterArgs>: Filter the results. The filter block is documented below.
Sorts List<Pulumi.DigitalOcean.Inputs.GetImagesSortArgs>: Sort the results. The sort block is documented below.

Filters []GetImagesFilter: Filter the results. The filter block is documented below.
Sorts []GetImagesSort: Sort the results. The sort block is documented below.

filters GetImagesFilter[]: Filter the results. The filter block is documented below.
sorts GetImagesSort[]: Sort the results. The sort block is documented below.

filters List[GetImagesFilter]: Filter the results. The filter block is documented below.
sorts List[GetImagesSort]: Sort the results. The sort block is documented below.

GetImages Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Images List<Pulumi.DigitalOcean.Outputs.GetImagesImage>: A set of images satisfying any filter and sort criteria. Each image has the following attributes:
- slug: Unique text identifier of the image. - id: The ID of the image. - name: The name of the image. - type: Type of the image. - distribution - The name of the distribution of the OS of the image. - min_disk_size: The minimum ‘disk’ required for the image. - size_gigabytes: The size of the image in GB. - private - Is image a public image or not. Public images represent Linux distributions or One-Click Applications, while non-public images represent snapshots and backups and are only available within your account. - regions: A set of the regions that the image is available in. - tags: A set of tags applied to the image - created: When the image was created - status: Current status of the image - error_message: Any applicable error message pertaining to the image - image - The id of the image (legacy parameter).
Filters List<Pulumi.DigitalOcean.Outputs.GetImagesFilter>
Sorts List<Pulumi.DigitalOcean.Outputs.GetImagesSort>

Id string: The provider-assigned unique ID for this managed resource.
Images []GetImagesImage: A set of images satisfying any filter and sort criteria. Each image has the following attributes:
- slug: Unique text identifier of the image. - id: The ID of the image. - name: The name of the image. - type: Type of the image. - distribution - The name of the distribution of the OS of the image. - min_disk_size: The minimum ‘disk’ required for the image. - size_gigabytes: The size of the image in GB. - private - Is image a public image or not. Public images represent Linux distributions or One-Click Applications, while non-public images represent snapshots and backups and are only available within your account. - regions: A set of the regions that the image is available in. - tags: A set of tags applied to the image - created: When the image was created - status: Current status of the image - error_message: Any applicable error message pertaining to the image - image - The id of the image (legacy parameter).
Filters []GetImagesFilter
Sorts []GetImagesSort

id string: The provider-assigned unique ID for this managed resource.
images GetImagesImage[]: A set of images satisfying any filter and sort criteria. Each image has the following attributes:
- slug: Unique text identifier of the image. - id: The ID of the image. - name: The name of the image. - type: Type of the image. - distribution - The name of the distribution of the OS of the image. - min_disk_size: The minimum ‘disk’ required for the image. - size_gigabytes: The size of the image in GB. - private - Is image a public image or not. Public images represent Linux distributions or One-Click Applications, while non-public images represent snapshots and backups and are only available within your account. - regions: A set of the regions that the image is available in. - tags: A set of tags applied to the image - created: When the image was created - status: Current status of the image - error_message: Any applicable error message pertaining to the image - image - The id of the image (legacy parameter).
filters GetImagesFilter[]
sorts GetImagesSort[]

id str: The provider-assigned unique ID for this managed resource.
images List[GetImagesImage]: A set of images satisfying any filter and sort criteria. Each image has the following attributes:
- slug: Unique text identifier of the image. - id: The ID of the image. - name: The name of the image. - type: Type of the image. - distribution - The name of the distribution of the OS of the image. - min_disk_size: The minimum ‘disk’ required for the image. - size_gigabytes: The size of the image in GB. - private - Is image a public image or not. Public images represent Linux distributions or One-Click Applications, while non-public images represent snapshots and backups and are only available within your account. - regions: A set of the regions that the image is available in. - tags: A set of tags applied to the image - created: When the image was created - status: Current status of the image - error_message: Any applicable error message pertaining to the image - image - The id of the image (legacy parameter).
filters List[GetImagesFilter]
sorts List[GetImagesSort]

Supporting Types

GetImagesFilter

See the input and output API doc for this type.

Key string: Filter the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, regions, size_gigabytes, slug, status, tags, or type.
Values List<string>: A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

Key string: Filter the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, regions, size_gigabytes, slug, status, tags, or type.
Values []string: A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

key string: Filter the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, regions, size_gigabytes, slug, status, tags, or type.
values string[]: A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

key str: Filter the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, regions, size_gigabytes, slug, status, tags, or type.
values List[str]: A list of values to match against the key field. Only retrieves images where the key field takes on one or more of the values provided here.

GetImagesImage

See the output API doc for this type.

Created string
Distribution string
ErrorMessage string
Id int
Image string
MinDiskSize int
Name string
Private bool
Regions []string
SizeGigabytes float64
Slug string
Status string
Tags []string
Type string

created str
distribution str
errorMessage str
id float
image str
min_disk_size float
name str
private bool
regions List[str]
sizeGigabytes float
slug str
status str
tags List[str]
type str

GetImagesSort

See the input and output API doc for this type.

Key string: Sort the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, size_gigabytes, slug, status, or type.
Direction string: The sort direction. This may be either asc or desc.

Key string: Sort the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, size_gigabytes, slug, status, or type.
Direction string: The sort direction. This may be either asc or desc.

key string: Sort the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, size_gigabytes, slug, status, or type.
direction string: The sort direction. This may be either asc or desc.

key str: Sort the images by this key. This may be one of distribution, error_message, id, image, min_disk_size, name, private, size_gigabytes, slug, status, or type.
direction str: The sort direction. This may be either asc or desc.

Package Details

Repository: https://github.com/pulumi/pulumi-digitalocean
License: Apache-2.0
Notes: This Pulumi package is based on the digitalocean Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud