Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. CustomImage
DigitalOcean v4.45.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-digitalocean

digitalocean.CustomImage

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.45.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-digitalocean

    Provides a resource which can be used to create a custom image from a URL. The URL must point to an image in one of the following file formats:

    • Raw (.img) with an MBR or GPT partition table
    • qcow2
    • VHDX
    • VDI
    • VMDK

    The image may be compressed using gzip or bzip2. See the DigitalOcean Custom Image documentation for additional requirements.

    Example Usage

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

const flatcar = new digitalocean.CustomImage("flatcar", {
    name: "flatcar",
    url: "https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2",
    regions: ["nyc3"],
});
const example = new digitalocean.Droplet("example", {
    image: flatcar.id,
    name: "example-01",
    region: digitalocean.Region.NYC3,
    size: digitalocean.DropletSlug.DropletS1VCPU1GB,
    sshKeys: ["12345"],
});

    import pulumi
import pulumi_digitalocean as digitalocean

flatcar = digitalocean.CustomImage("flatcar",
    name="flatcar",
    url="https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2",
    regions=["nyc3"])
example = digitalocean.Droplet("example",
    image=flatcar.id,
    name="example-01",
    region=digitalocean.Region.NYC3,
    size=digitalocean.DropletSlug.DROPLET_S1_VCPU1_GB,
    ssh_keys=["12345"])

    package main

import (
	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		flatcar, err := digitalocean.NewCustomImage(ctx, "flatcar", &digitalocean.CustomImageArgs{
			Name: pulumi.String("flatcar"),
			Url:  pulumi.String("https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2"),
			Regions: pulumi.StringArray{
				pulumi.String("nyc3"),
			},
		})
		if err != nil {
			return err
		}
		_, err = digitalocean.NewDroplet(ctx, "example", &digitalocean.DropletArgs{
			Image:  flatcar.ID(),
			Name:   pulumi.String("example-01"),
			Region: pulumi.String(digitalocean.RegionNYC3),
			Size:   pulumi.String(digitalocean.DropletSlugDropletS1VCPU1GB),
			SshKeys: pulumi.StringArray{
				pulumi.String("12345"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using DigitalOcean = Pulumi.DigitalOcean;

return await Deployment.RunAsync(() => 
{
    var flatcar = new DigitalOcean.CustomImage("flatcar", new()
    {
        Name = "flatcar",
        Url = "https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2",
        Regions = new[]
        {
            "nyc3",
        },
    });

    var example = new DigitalOcean.Droplet("example", new()
    {
        Image = flatcar.Id,
        Name = "example-01",
        Region = DigitalOcean.Region.NYC3,
        Size = DigitalOcean.DropletSlug.DropletS1VCPU1GB,
        SshKeys = new[]
        {
            "12345",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.digitalocean.CustomImage;
import com.pulumi.digitalocean.CustomImageArgs;
import com.pulumi.digitalocean.Droplet;
import com.pulumi.digitalocean.DropletArgs;
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) {
        var flatcar = new CustomImage("flatcar", CustomImageArgs.builder()
            .name("flatcar")
            .url("https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2")
            .regions("nyc3")
            .build());

        var example = new Droplet("example", DropletArgs.builder()
            .image(flatcar.id())
            .name("example-01")
            .region("nyc3")
            .size("s-1vcpu-1gb")
            .sshKeys("12345")
            .build());

    }
}

    resources:
  flatcar:
    type: digitalocean:CustomImage
    properties:
      name: flatcar
      url: https://stable.release.flatcar-linux.net/amd64-usr/2605.7.0/flatcar_production_digitalocean_image.bin.bz2
      regions:
        - nyc3
  example:
    type: digitalocean:Droplet
    properties:
      image: ${flatcar.id}
      name: example-01
      region: nyc3
      size: s-1vcpu-1gb
      sshKeys:
        - 12345

    Create CustomImage Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new CustomImage(name: string, args: CustomImageArgs, opts?: CustomResourceOptions);
    @overload
def CustomImage(resource_name: str,
                args: CustomImageArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def CustomImage(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                regions: Optional[Sequence[str]] = None,
                url: Optional[str] = None,
                description: Optional[str] = None,
                distribution: Optional[str] = None,
                name: Optional[str] = None,
                tags: Optional[Sequence[str]] = None)
    func NewCustomImage(ctx *Context, name string, args CustomImageArgs, opts ...ResourceOption) (*CustomImage, error)
    public CustomImage(string name, CustomImageArgs args, CustomResourceOptions? opts = null)
    public CustomImage(String name, CustomImageArgs args)
public CustomImage(String name, CustomImageArgs args, CustomResourceOptions options)

    type: digitalocean:CustomImage
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CustomImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CustomImageArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CustomImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CustomImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CustomImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var customImageResource = new DigitalOcean.CustomImage("customImageResource", new()
{
    Regions = new[]
    {
        "string",
    },
    Url = "string",
    Description = "string",
    Distribution = "string",
    Name = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := digitalocean.NewCustomImage(ctx, "customImageResource", &digitalocean.CustomImageArgs{
	Regions: pulumi.StringArray{
		pulumi.String("string"),
	},
	Url:          pulumi.String("string"),
	Description:  pulumi.String("string"),
	Distribution: pulumi.String("string"),
	Name:         pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var customImageResource = new CustomImage("customImageResource", CustomImageArgs.builder()
    .regions("string")
    .url("string")
    .description("string")
    .distribution("string")
    .name("string")
    .tags("string")
    .build());

    custom_image_resource = digitalocean.CustomImage("customImageResource",
    regions=["string"],
    url="string",
    description="string",
    distribution="string",
    name="string",
    tags=["string"])

    const customImageResource = new digitalocean.CustomImage("customImageResource", {
    regions: ["string"],
    url: "string",
    description: "string",
    distribution: "string",
    name: "string",
    tags: ["string"],
});

    type: digitalocean:CustomImage
properties:
    description: string
    distribution: string
    name: string
    regions:
        - string
    tags:
        - string
    url: string

    CustomImage Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CustomImage resource accepts the following input properties:

    Regions List<string>
    A list of regions. (Currently only one is supported).
    Url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    Description string
    An optional description for the image.
    Distribution string
    An optional distribution name for the image. Valid values are documented here
    Name string
    A name for the Custom Image.
    Tags List<string>
    A list of optional tags for the image.
    Regions []string
    A list of regions. (Currently only one is supported).
    Url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    Description string
    An optional description for the image.
    Distribution string
    An optional distribution name for the image. Valid values are documented here
    Name string
    A name for the Custom Image.
    Tags []string
    A list of optional tags for the image.
    regions List<String>
    A list of regions. (Currently only one is supported).
    url String
    A URL from which the custom Linux virtual machine image may be retrieved.
    description String
    An optional description for the image.
    distribution String
    An optional distribution name for the image. Valid values are documented here
    name String
    A name for the Custom Image.
    tags List<String>
    A list of optional tags for the image.
    regions string[]
    A list of regions. (Currently only one is supported).
    url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    description string
    An optional description for the image.
    distribution string
    An optional distribution name for the image. Valid values are documented here
    name string
    A name for the Custom Image.
    tags string[]
    A list of optional tags for the image.
    regions Sequence[str]
    A list of regions. (Currently only one is supported).
    url str
    A URL from which the custom Linux virtual machine image may be retrieved.
    description str
    An optional description for the image.
    distribution str
    An optional distribution name for the image. Valid values are documented here
    name str
    A name for the Custom Image.
    tags Sequence[str]
    A list of optional tags for the image.
    regions List<String>
    A list of regions. (Currently only one is supported).
    url String
    A URL from which the custom Linux virtual machine image may be retrieved.
    description String
    An optional description for the image.
    distribution String
    An optional distribution name for the image. Valid values are documented here
    name String
    A name for the Custom Image.
    tags List<String>
    A list of optional tags for the image.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CustomImage resource produces the following output properties:

    CreatedAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId int
    A unique number that can be used to identify and reference a specific image.
    MinDiskSize int
    The minimum disk size in GB required for a Droplet to use this image.
    Public bool
    Indicates whether the image in question is public or not.
    SizeGigabytes double
    The size of the image in gigabytes.
    Slug string
    A uniquely identifying string for each image.
    Status string
    A status string indicating the state of a custom image.
    Type string
    Describes the kind of image.
    CreatedAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId int
    A unique number that can be used to identify and reference a specific image.
    MinDiskSize int
    The minimum disk size in GB required for a Droplet to use this image.
    Public bool
    Indicates whether the image in question is public or not.
    SizeGigabytes float64
    The size of the image in gigabytes.
    Slug string
    A uniquely identifying string for each image.
    Status string
    A status string indicating the state of a custom image.
    Type string
    Describes the kind of image.
    createdAt String
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId Integer
    A unique number that can be used to identify and reference a specific image.
    minDiskSize Integer
    The minimum disk size in GB required for a Droplet to use this image.
    public_ Boolean
    Indicates whether the image in question is public or not.
    sizeGigabytes Double
    The size of the image in gigabytes.
    slug String
    A uniquely identifying string for each image.
    status String
    A status string indicating the state of a custom image.
    type String
    Describes the kind of image.
    createdAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    id string
    The provider-assigned unique ID for this managed resource.
    imageId number
    A unique number that can be used to identify and reference a specific image.
    minDiskSize number
    The minimum disk size in GB required for a Droplet to use this image.
    public boolean
    Indicates whether the image in question is public or not.
    sizeGigabytes number
    The size of the image in gigabytes.
    slug string
    A uniquely identifying string for each image.
    status string
    A status string indicating the state of a custom image.
    type string
    Describes the kind of image.
    created_at str
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    id str
    The provider-assigned unique ID for this managed resource.
    image_id int
    A unique number that can be used to identify and reference a specific image.
    min_disk_size int
    The minimum disk size in GB required for a Droplet to use this image.
    public bool
    Indicates whether the image in question is public or not.
    size_gigabytes float
    The size of the image in gigabytes.
    slug str
    A uniquely identifying string for each image.
    status str
    A status string indicating the state of a custom image.
    type str
    Describes the kind of image.
    createdAt String
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    id String
    The provider-assigned unique ID for this managed resource.
    imageId Number
    A unique number that can be used to identify and reference a specific image.
    minDiskSize Number
    The minimum disk size in GB required for a Droplet to use this image.
    public Boolean
    Indicates whether the image in question is public or not.
    sizeGigabytes Number
    The size of the image in gigabytes.
    slug String
    A uniquely identifying string for each image.
    status String
    A status string indicating the state of a custom image.
    type String
    Describes the kind of image.

    Look up Existing CustomImage Resource

    Get an existing CustomImage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CustomImageState, opts?: CustomResourceOptions): CustomImage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        distribution: Optional[str] = None,
        image_id: Optional[int] = None,
        min_disk_size: Optional[int] = None,
        name: Optional[str] = None,
        public: Optional[bool] = None,
        regions: Optional[Sequence[str]] = None,
        size_gigabytes: Optional[float] = None,
        slug: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        type: Optional[str] = None,
        url: Optional[str] = None) -> CustomImage
    func GetCustomImage(ctx *Context, name string, id IDInput, state *CustomImageState, opts ...ResourceOption) (*CustomImage, error)
    public static CustomImage Get(string name, Input<string> id, CustomImageState? state, CustomResourceOptions? opts = null)
    public static CustomImage get(String name, Output<String> id, CustomImageState state, CustomResourceOptions options)
    resources:  _:    type: digitalocean:CustomImage    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    Description string
    An optional description for the image.
    Distribution string
    An optional distribution name for the image. Valid values are documented here
    ImageId int
    A unique number that can be used to identify and reference a specific image.
    MinDiskSize int
    The minimum disk size in GB required for a Droplet to use this image.
    Name string
    A name for the Custom Image.
    Public bool
    Indicates whether the image in question is public or not.
    Regions List<string>
    A list of regions. (Currently only one is supported).
    SizeGigabytes double
    The size of the image in gigabytes.
    Slug string
    A uniquely identifying string for each image.
    Status string
    A status string indicating the state of a custom image.
    Tags List<string>
    A list of optional tags for the image.
    Type string
    Describes the kind of image.
    Url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    CreatedAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    Description string
    An optional description for the image.
    Distribution string
    An optional distribution name for the image. Valid values are documented here
    ImageId int
    A unique number that can be used to identify and reference a specific image.
    MinDiskSize int
    The minimum disk size in GB required for a Droplet to use this image.
    Name string
    A name for the Custom Image.
    Public bool
    Indicates whether the image in question is public or not.
    Regions []string
    A list of regions. (Currently only one is supported).
    SizeGigabytes float64
    The size of the image in gigabytes.
    Slug string
    A uniquely identifying string for each image.
    Status string
    A status string indicating the state of a custom image.
    Tags []string
    A list of optional tags for the image.
    Type string
    Describes the kind of image.
    Url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    createdAt String
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    description String
    An optional description for the image.
    distribution String
    An optional distribution name for the image. Valid values are documented here
    imageId Integer
    A unique number that can be used to identify and reference a specific image.
    minDiskSize Integer
    The minimum disk size in GB required for a Droplet to use this image.
    name String
    A name for the Custom Image.
    public_ Boolean
    Indicates whether the image in question is public or not.
    regions List<String>
    A list of regions. (Currently only one is supported).
    sizeGigabytes Double
    The size of the image in gigabytes.
    slug String
    A uniquely identifying string for each image.
    status String
    A status string indicating the state of a custom image.
    tags List<String>
    A list of optional tags for the image.
    type String
    Describes the kind of image.
    url String
    A URL from which the custom Linux virtual machine image may be retrieved.
    createdAt string
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    description string
    An optional description for the image.
    distribution string
    An optional distribution name for the image. Valid values are documented here
    imageId number
    A unique number that can be used to identify and reference a specific image.
    minDiskSize number
    The minimum disk size in GB required for a Droplet to use this image.
    name string
    A name for the Custom Image.
    public boolean
    Indicates whether the image in question is public or not.
    regions string[]
    A list of regions. (Currently only one is supported).
    sizeGigabytes number
    The size of the image in gigabytes.
    slug string
    A uniquely identifying string for each image.
    status string
    A status string indicating the state of a custom image.
    tags string[]
    A list of optional tags for the image.
    type string
    Describes the kind of image.
    url string
    A URL from which the custom Linux virtual machine image may be retrieved.
    created_at str
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    description str
    An optional description for the image.
    distribution str
    An optional distribution name for the image. Valid values are documented here
    image_id int
    A unique number that can be used to identify and reference a specific image.
    min_disk_size int
    The minimum disk size in GB required for a Droplet to use this image.
    name str
    A name for the Custom Image.
    public bool
    Indicates whether the image in question is public or not.
    regions Sequence[str]
    A list of regions. (Currently only one is supported).
    size_gigabytes float
    The size of the image in gigabytes.
    slug str
    A uniquely identifying string for each image.
    status str
    A status string indicating the state of a custom image.
    tags Sequence[str]
    A list of optional tags for the image.
    type str
    Describes the kind of image.
    url str
    A URL from which the custom Linux virtual machine image may be retrieved.
    createdAt String
    A time value given in ISO8601 combined date and time format that represents when the image was created.
    description String
    An optional description for the image.
    distribution String
    An optional distribution name for the image. Valid values are documented here
    imageId Number
    A unique number that can be used to identify and reference a specific image.
    minDiskSize Number
    The minimum disk size in GB required for a Droplet to use this image.
    name String
    A name for the Custom Image.
    public Boolean
    Indicates whether the image in question is public or not.
    regions List<String>
    A list of regions. (Currently only one is supported).
    sizeGigabytes Number
    The size of the image in gigabytes.
    slug String
    A uniquely identifying string for each image.
    status String
    A status string indicating the state of a custom image.
    tags List<String>
    A list of optional tags for the image.
    type String
    Describes the kind of image.
    url String
    A URL from which the custom Linux virtual machine image may be retrieved.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.45.0 published on Tuesday, May 20, 2025 by Pulumi
    pulumi/pulumi-digitalocean