@pulumi/digitalocean 4.7.0-alpha.1633346817

package/getDroplets.d.ts

@@ -0,0 +1,85 @@
+import * as pulumi from "@pulumi/pulumi";
+import { input as inputs, output as outputs } from "./types";
+/**
+ * Get information on Droplets for use in other resources, with the ability to filter and sort the results.
+ * If no filters are specified, all Droplets will be returned.
+ *
+ * This data source is useful if the Droplets in question are not managed by the provider or you need to
+ * utilize any of the Droplets' data.
+ *
+ * Note: You can use the `digitalocean.Droplet` data source to obtain metadata
+ * about a single Droplet if you already know the `id`, unique `name`, or unique `tag` to retrieve.
+ *
+ * ## Example Usage
+ *
+ * Use the `filter` block with a `key` string and `values` list to filter images.
+ *
+ * For example to find all Droplets with size `s-1vcpu-1gb`:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const small = pulumi.output(digitalocean.getDroplets({
+ *     filters: [{
+ *         key: "size",
+ *         values: ["s-1vcpu-1gb"],
+ *     }],
+ * }));
+ * ```
+ *
+ * You can filter on multiple fields and sort the results as well:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const small_with_backups = pulumi.output(digitalocean.getDroplets({
+ *     filters: [
+ *         {
+ *             key: "size",
+ *             values: ["s-1vcpu-1gb"],
+ *         },
+ *         {
+ *             key: "backups",
+ *             values: ["true"],
+ *         },
+ *     ],
+ *     sorts: [{
+ *         direction: "desc",
+ *         key: "created_at",
+ *     }],
+ * }));
+ * ```
+ */
+export declare function getDroplets(args?: GetDropletsArgs, opts?: pulumi.InvokeOptions): Promise<GetDropletsResult>;
+/**
+ * A collection of arguments for invoking getDroplets.
+ */
+export interface GetDropletsArgs {
+    /**
+     * Filter the results.
+     * The `filter` block is documented below.
+     */
+    filters?: inputs.GetDropletsFilter[];
+    /**
+     * Sort the results.
+     * The `sort` block is documented below.
+     */
+    sorts?: inputs.GetDropletsSort[];
+}
+/**
+ * A collection of values returned by getDroplets.
+ */
+export interface GetDropletsResult {
+    /**
+     * A list of Droplets satisfying any `filter` and `sort` criteria. Each Droplet has the following attributes:
+     */
+    readonly droplets: outputs.GetDropletsDroplet[];
+    readonly filters?: outputs.GetDropletsFilter[];
+    /**
+     * The provider-assigned unique ID for this managed resource.
+     */
+    readonly id: string;
+    readonly sorts?: outputs.GetDropletsSort[];
+}

package/getDroplets.js

@@ -0,0 +1,73 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Get information on Droplets for use in other resources, with the ability to filter and sort the results.
+ * If no filters are specified, all Droplets will be returned.
+ *
+ * This data source is useful if the Droplets in question are not managed by the provider or you need to
+ * utilize any of the Droplets' data.
+ *
+ * Note: You can use the `digitalocean.Droplet` data source to obtain metadata
+ * about a single Droplet if you already know the `id`, unique `name`, or unique `tag` to retrieve.
+ *
+ * ## Example Usage
+ *
+ * Use the `filter` block with a `key` string and `values` list to filter images.
+ *
+ * For example to find all Droplets with size `s-1vcpu-1gb`:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const small = pulumi.output(digitalocean.getDroplets({
+ *     filters: [{
+ *         key: "size",
+ *         values: ["s-1vcpu-1gb"],
+ *     }],
+ * }));
+ * ```
+ *
+ * You can filter on multiple fields and sort the results as well:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const small_with_backups = pulumi.output(digitalocean.getDroplets({
+ *     filters: [
+ *         {
+ *             key: "size",
+ *             values: ["s-1vcpu-1gb"],
+ *         },
+ *         {
+ *             key: "backups",
+ *             values: ["true"],
+ *         },
+ *     ],
+ *     sorts: [{
+ *         direction: "desc",
+ *         key: "created_at",
+ *     }],
+ * }));
+ * ```
+ */
+function getDroplets(args, opts) {
+    args = args || {};
+    if (!opts) {
+        opts = {};
+    }
+    if (!opts.version) {
+        opts.version = utilities.getVersion();
+    }
+    return pulumi.runtime.invoke("digitalocean:index/getDroplets:getDroplets", {
+        "filters": args.filters,
+        "sorts": args.sorts,
+    }, opts);
+}
+exports.getDroplets = getDroplets;
+//# sourceMappingURL=getDroplets.js.map

package/getDroplets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDroplets.js","sourceRoot":"","sources":["../getDroplets.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,WAAW,CAAC,IAAsB,EAAE,IAA2B;IAC3E,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;KACzC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4CAA4C,EAAE;QACvE,SAAS,EAAE,IAAI,CAAC,OAAO;QACvB,OAAO,EAAE,IAAI,CAAC,KAAK;KACtB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAbD,kCAaC"}

package/getFirewall.d.ts

@@ -0,0 +1,83 @@
+import * as pulumi from "@pulumi/pulumi";
+import { input as inputs, output as outputs } from "./types";
+/**
+ * Get information on a DigitalOcean Firewall.
+ *
+ * ## Example Usage
+ *
+ * Get the firewall:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example = digitalocean.getFirewall({
+ *     firewallId: "1df48973-6eef-4214-854f-fa7726e7e583",
+ * });
+ * export const exampleFirewallName = example.then(example => example.name);
+ * ```
+ */
+export declare function getFirewall(args: GetFirewallArgs, opts?: pulumi.InvokeOptions): Promise<GetFirewallResult>;
+/**
+ * A collection of arguments for invoking getFirewall.
+ */
+export interface GetFirewallArgs {
+    /**
+     * The list of the IDs of the Droplets assigned to
+     * the Firewall.
+     */
+    dropletIds?: number[];
+    /**
+     * The ID of the firewall to retrieve information
+     * about.
+     */
+    firewallId: string;
+    inboundRules?: inputs.GetFirewallInboundRule[];
+    outboundRules?: inputs.GetFirewallOutboundRule[];
+    /**
+     * The names of the Tags assigned to the Firewall.
+     */
+    tags?: string[];
+}
+/**
+ * A collection of values returned by getFirewall.
+ */
+export interface GetFirewallResult {
+    /**
+     * A time value given in ISO8601 combined date and time format
+     * that represents when the Firewall was created.
+     */
+    readonly createdAt: string;
+    /**
+     * The list of the IDs of the Droplets assigned to
+     * the Firewall.
+     */
+    readonly dropletIds: number[];
+    readonly firewallId: string;
+    /**
+     * The provider-assigned unique ID for this managed resource.
+     */
+    readonly id: string;
+    readonly inboundRules: outputs.GetFirewallInboundRule[];
+    /**
+     * The name of the Firewall.
+     */
+    readonly name: string;
+    readonly outboundRules: outputs.GetFirewallOutboundRule[];
+    /**
+     * A set of object containing the fields, `dropletId`,
+     * `removing`, and `status`.  It is provided to detail exactly which Droplets
+     * are having their security policies updated.  When empty, all changes
+     * have been successfully applied.
+     */
+    readonly pendingChanges: outputs.GetFirewallPendingChange[];
+    /**
+     * A status string indicating the current state of the Firewall.
+     * This can be "waiting", "succeeded", or "failed".
+     */
+    readonly status: string;
+    /**
+     * The names of the Tags assigned to the Firewall.
+     */
+    readonly tags: string[];
+}

package/getFirewall.js

@@ -0,0 +1,40 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Get information on a DigitalOcean Firewall.
+ *
+ * ## Example Usage
+ *
+ * Get the firewall:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example = digitalocean.getFirewall({
+ *     firewallId: "1df48973-6eef-4214-854f-fa7726e7e583",
+ * });
+ * export const exampleFirewallName = example.then(example => example.name);
+ * ```
+ */
+function getFirewall(args, opts) {
+    if (!opts) {
+        opts = {};
+    }
+    if (!opts.version) {
+        opts.version = utilities.getVersion();
+    }
+    return pulumi.runtime.invoke("digitalocean:index/getFirewall:getFirewall", {
+        "dropletIds": args.dropletIds,
+        "firewallId": args.firewallId,
+        "inboundRules": args.inboundRules,
+        "outboundRules": args.outboundRules,
+        "tags": args.tags,
+    }, opts);
+}
+exports.getFirewall = getFirewall;
+//# sourceMappingURL=getFirewall.js.map

package/getFirewall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFirewall.js","sourceRoot":"","sources":["../getFirewall.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,WAAW,CAAC,IAAqB,EAAE,IAA2B;IAC1E,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;KACzC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,4CAA4C,EAAE;QACvE,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,cAAc,EAAE,IAAI,CAAC,YAAY;QACjC,eAAe,EAAE,IAAI,CAAC,aAAa;QACnC,MAAM,EAAE,IAAI,CAAC,IAAI;KACpB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAfD,kCAeC"}

package/getFloatingIp.d.ts

@@ -0,0 +1,48 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * Get information on a floating ip. This data source provides the region and Droplet id
+ * as configured on your DigitalOcean account. This is useful if the floating IP
+ * in question is not managed by the provider or you need to find the Droplet the IP is
+ * attached to.
+ *
+ * An error is triggered if the provided floating IP does not exist.
+ *
+ * ## Example Usage
+ *
+ * Get the floating IP:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const config = new pulumi.Config();
+ * const publicIp = config.requireObject("publicIp");
+ * const example = digitalocean.getFloatingIp({
+ *     ipAddress: publicIp,
+ * });
+ * export const fipOutput = example.then(example => example.dropletId);
+ * ```
+ */
+export declare function getFloatingIp(args: GetFloatingIpArgs, opts?: pulumi.InvokeOptions): Promise<GetFloatingIpResult>;
+/**
+ * A collection of arguments for invoking getFloatingIp.
+ */
+export interface GetFloatingIpArgs {
+    /**
+     * The allocated IP address of the specific floating IP to retrieve.
+     */
+    ipAddress: string;
+}
+/**
+ * A collection of values returned by getFloatingIp.
+ */
+export interface GetFloatingIpResult {
+    readonly dropletId: number;
+    readonly floatingIpUrn: string;
+    /**
+     * The provider-assigned unique ID for this managed resource.
+     */
+    readonly id: string;
+    readonly ipAddress: string;
+    readonly region: string;
+}

package/getFloatingIp.js

@@ -0,0 +1,43 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Get information on a floating ip. This data source provides the region and Droplet id
+ * as configured on your DigitalOcean account. This is useful if the floating IP
+ * in question is not managed by the provider or you need to find the Droplet the IP is
+ * attached to.
+ *
+ * An error is triggered if the provided floating IP does not exist.
+ *
+ * ## Example Usage
+ *
+ * Get the floating IP:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const config = new pulumi.Config();
+ * const publicIp = config.requireObject("publicIp");
+ * const example = digitalocean.getFloatingIp({
+ *     ipAddress: publicIp,
+ * });
+ * export const fipOutput = example.then(example => example.dropletId);
+ * ```
+ */
+function getFloatingIp(args, opts) {
+    if (!opts) {
+        opts = {};
+    }
+    if (!opts.version) {
+        opts.version = utilities.getVersion();
+    }
+    return pulumi.runtime.invoke("digitalocean:index/getFloatingIp:getFloatingIp", {
+        "ipAddress": args.ipAddress,
+    }, opts);
+}
+exports.getFloatingIp = getFloatingIp;
+//# sourceMappingURL=getFloatingIp.js.map

package/getFloatingIp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFloatingIp.js","sourceRoot":"","sources":["../getFloatingIp.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,aAAa,CAAC,IAAuB,EAAE,IAA2B;IAC9E,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;KACzC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gDAAgD,EAAE;QAC3E,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAXD,sCAWC"}

package/getImage.d.ts

@@ -0,0 +1,110 @@
+import * as pulumi from "@pulumi/pulumi";
+/**
+ * Get information on an image for use in other resources (e.g. creating a Droplet
+ * based on snapshot). This data source provides all of the image properties as
+ * configured on your DigitalOcean account. This is useful if the image in question
+ * is not managed by the provider or you need to utilize any of the image's data.
+ *
+ * An error is triggered if zero or more than one result is returned by the query.
+ *
+ * ## Example Usage
+ *
+ * Get the data about a snapshot:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example1 = pulumi.output(digitalocean.getImage({
+ *     name: "example-1.0.0",
+ * }));
+ * ```
+ *
+ * Reuse the data about a snapshot to create a Droplet:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const exampleImage = digitalocean.getImage({
+ *     name: "example-1.0.0",
+ * });
+ * const exampleDroplet = new digitalocean.Droplet("exampleDroplet", {
+ *     image: exampleImage.then(exampleImage => exampleImage.id),
+ *     region: "nyc2",
+ *     size: "s-1vcpu-1gb",
+ * });
+ * ```
+ *
+ * Get the data about an official image:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example2 = pulumi.output(digitalocean.getImage({
+ *     slug: "ubuntu-18-04-x64",
+ * }));
+ * ```
+ */
+export declare function getImage(args?: GetImageArgs, opts?: pulumi.InvokeOptions): Promise<GetImageResult>;
+/**
+ * A collection of arguments for invoking getImage.
+ */
+export interface GetImageArgs {
+    /**
+     * The id of the image
+     */
+    id?: number;
+    /**
+     * The name of the image.
+     */
+    name?: string;
+    /**
+     * The slug of the official image.
+     */
+    slug?: string;
+    /**
+     * Restrict the search to one of the following categories of images:
+     */
+    source?: string;
+}
+/**
+ * A collection of values returned by getImage.
+ */
+export interface GetImageResult {
+    readonly created: string;
+    readonly description: string;
+    /**
+     * The name of the distribution of the OS of the image.
+     * * `minDiskSize`: The minimum 'disk' required for the image.
+     * * `sizeGigabytes`: The size of the image in GB.
+     */
+    readonly distribution: string;
+    readonly errorMessage: string;
+    readonly id: number;
+    /**
+     * The id of the image (legacy parameter).
+     */
+    readonly image: string;
+    readonly minDiskSize: number;
+    readonly name: string;
+    /**
+     * 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
+     * * `errorMessage`: Any applicable error message pertaining to the image
+     */
+    readonly private: boolean;
+    readonly regions: string[];
+    readonly sizeGigabytes: number;
+    readonly slug: string;
+    readonly source?: string;
+    readonly status: string;
+    readonly tags: string[];
+    readonly type: string;
+}

package/getImage.js

@@ -0,0 +1,71 @@
+"use strict";
+// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
+// *** Do not edit by hand unless you're certain you know what you are doing! ***
+Object.defineProperty(exports, "__esModule", { value: true });
+const pulumi = require("@pulumi/pulumi");
+const utilities = require("./utilities");
+/**
+ * Get information on an image for use in other resources (e.g. creating a Droplet
+ * based on snapshot). This data source provides all of the image properties as
+ * configured on your DigitalOcean account. This is useful if the image in question
+ * is not managed by the provider or you need to utilize any of the image's data.
+ *
+ * An error is triggered if zero or more than one result is returned by the query.
+ *
+ * ## Example Usage
+ *
+ * Get the data about a snapshot:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example1 = pulumi.output(digitalocean.getImage({
+ *     name: "example-1.0.0",
+ * }));
+ * ```
+ *
+ * Reuse the data about a snapshot to create a Droplet:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const exampleImage = digitalocean.getImage({
+ *     name: "example-1.0.0",
+ * });
+ * const exampleDroplet = new digitalocean.Droplet("exampleDroplet", {
+ *     image: exampleImage.then(exampleImage => exampleImage.id),
+ *     region: "nyc2",
+ *     size: "s-1vcpu-1gb",
+ * });
+ * ```
+ *
+ * Get the data about an official image:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const example2 = pulumi.output(digitalocean.getImage({
+ *     slug: "ubuntu-18-04-x64",
+ * }));
+ * ```
+ */
+function getImage(args, opts) {
+    args = args || {};
+    if (!opts) {
+        opts = {};
+    }
+    if (!opts.version) {
+        opts.version = utilities.getVersion();
+    }
+    return pulumi.runtime.invoke("digitalocean:index/getImage:getImage", {
+        "id": args.id,
+        "name": args.name,
+        "slug": args.slug,
+        "source": args.source,
+    }, opts);
+}
+exports.getImage = getImage;
+//# sourceMappingURL=getImage.js.map

package/getImage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getImage.js","sourceRoot":"","sources":["../getImage.ts"],"names":[],"mappings":";AAAA,wFAAwF;AACxF,iFAAiF;;AAEjF,yCAAyC;AAEzC,yCAAyC;AAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,SAAgB,QAAQ,CAAC,IAAmB,EAAE,IAA2B;IACrE,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAClB,IAAI,CAAC,IAAI,EAAE;QACP,IAAI,GAAG,EAAE,CAAA;KACZ;IAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;QACf,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC,UAAU,EAAE,CAAC;KACzC;IACD,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,sCAAsC,EAAE;QACjE,IAAI,EAAE,IAAI,CAAC,EAAE;QACb,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,QAAQ,EAAE,IAAI,CAAC,MAAM;KACxB,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAfD,4BAeC"}

package/getImages.d.ts

@@ -0,0 +1,90 @@
+import * as pulumi from "@pulumi/pulumi";
+import { input as inputs, output as outputs } from "./types";
+/**
+ * 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 the 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
+ *
+ * Use the `filter` block with a `key` string and `values` list to filter images.
+ *
+ * For example to find all Ubuntu images:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const ubuntu = pulumi.output(digitalocean.getImages({
+ *     filters: [{
+ *         key: "distribution",
+ *         values: ["Ubuntu"],
+ *     }],
+ * }));
+ * ```
+ *
+ * You can filter on multiple fields and sort the results as well:
+ *
+ * ```typescript
+ * import * as pulumi from "@pulumi/pulumi";
+ * import * as digitalocean from "@pulumi/digitalocean";
+ *
+ * const available = pulumi.output(digitalocean.getImages({
+ *     filters: [
+ *         {
+ *             key: "distribution",
+ *             values: ["Ubuntu"],
+ *         },
+ *         {
+ *             key: "regions",
+ *             values: ["nyc3"],
+ *         },
+ *     ],
+ *     sorts: [{
+ *         direction: "desc",
+ *         key: "created",
+ *     }],
+ * }));
+ * ```
+ */
+export declare function getImages(args?: GetImagesArgs, opts?: pulumi.InvokeOptions): Promise<GetImagesResult>;
+/**
+ * A collection of arguments for invoking getImages.
+ */
+export interface GetImagesArgs {
+    /**
+     * Filter the results.
+     * The `filter` block is documented below.
+     */
+    filters?: inputs.GetImagesFilter[];
+    /**
+     * Sort the results.
+     * The `sort` block is documented below.
+     */
+    sorts?: inputs.GetImagesSort[];
+}
+/**
+ * A collection of values returned by getImages.
+ */
+export interface GetImagesResult {
+    readonly filters?: outputs.GetImagesFilter[];
+    /**
+     * The provider-assigned unique ID for this managed resource.
+     */
+    readonly id: string;
+    /**
+     * 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.
+     */
+    readonly images: outputs.GetImagesImage[];
+    readonly sorts?: outputs.GetImagesSort[];
+}