CustomImageArgs

data class CustomImageArgs(val description: Output<String>? = null, val distribution: Output<String>? = null, val name: Output<String>? = null, val regions: Output<List<String>>? = null, val tags: Output<List<String>>? = null, val url: Output<String>? = null) : ConvertibleToJava<CustomImageArgs>

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"])
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 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
})
}
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

Constructors

Link copied to clipboard
constructor(description: Output<String>? = null, distribution: Output<String>? = null, name: Output<String>? = null, regions: Output<List<String>>? = null, tags: Output<List<String>>? = null, url: Output<String>? = null)

Properties

Link copied to clipboard
val description: Output<String>? = null

An optional description for the image.

Link copied to clipboard
val distribution: Output<String>? = null

An optional distribution name for the image. Valid values are documented here

Link copied to clipboard
val name: Output<String>? = null

A name for the Custom Image.

Link copied to clipboard
val regions: Output<List<String>>? = null

A list of regions. (Currently only one is supported).

Link copied to clipboard
val tags: Output<List<String>>? = null

A list of optional tags for the image.

Link copied to clipboard
val url: Output<String>? = null

A URL from which the custom Linux virtual machine image may be retrieved.

Functions

Link copied to clipboard
open override fun toJava(): CustomImageArgs