Docs Packages
  1. Packages
  2. Vultr
  3. API Docs
  4. Instance
Vultr v2.19.0 published on Friday, Jan 5, 2024 by dirien
dirien/pulumi-vultr

vultr.Instance

Explore with Pulumi AI

vultr logo
Vultr v2.19.0 published on Friday, Jan 5, 2024 by dirien
dirien/pulumi-vultr

    Provides a Vultr instance resource. This can be used to create, read, modify, and delete instances on your Vultr account.

    Example Usage

    Create a new instance

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myInstance = new Vultr.Instance("myInstance", new()
    {
        OsId = 1743,
        Plan = "vc2-1c-2gb",
        Region = "sea",
    });

});

    package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewInstance(ctx, "myInstance", &vultr.InstanceArgs{
			OsId:   pulumi.Int(1743),
			Plan:   pulumi.String("vc2-1c-2gb"),
			Region: pulumi.String("sea"),
		})
		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.vultr.Instance;
import com.pulumi.vultr.InstanceArgs;
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 myInstance = new Instance("myInstance", InstanceArgs.builder()        
            .osId(1743)
            .plan("vc2-1c-2gb")
            .region("sea")
            .build());

    }
}

    import pulumi
import ediri_vultr as vultr

my_instance = vultr.Instance("myInstance",
    os_id=1743,
    plan="vc2-1c-2gb",
    region="sea")

    import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myInstance = new vultr.Instance("myInstance", {
    osId: 1743,
    plan: "vc2-1c-2gb",
    region: "sea",
});

    resources:
  myInstance:
    type: vultr:Instance
    properties:
      osId: 1743
      plan: vc2-1c-2gb
      region: sea

    Create a new instance with options

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vultr = ediri.Vultr;

return await Deployment.RunAsync(() => 
{
    var myInstance = new Vultr.Instance("myInstance", new()
    {
        ActivationEmail = false,
        Backups = "enabled",
        BackupsSchedule = new Vultr.Inputs.InstanceBackupsScheduleArgs
        {
            Type = "daily",
        },
        DdosProtection = true,
        DisablePublicIpv4 = true,
        EnableIpv6 = true,
        Hostname = "my-instance-hostname",
        Label = "my-instance-label",
        OsId = 1743,
        Plan = "vc2-1c-2gb",
        Region = "sea",
        Tags = new[]
        {
            "my-instance-tag",
        },
    });

});

    package main

import (
	"github.com/dirien/pulumi-vultr/sdk/v2/go/vultr"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vultr.NewInstance(ctx, "myInstance", &vultr.InstanceArgs{
			ActivationEmail: pulumi.Bool(false),
			Backups:         pulumi.String("enabled"),
			BackupsSchedule: &vultr.InstanceBackupsScheduleArgs{
				Type: pulumi.String("daily"),
			},
			DdosProtection:    pulumi.Bool(true),
			DisablePublicIpv4: pulumi.Bool(true),
			EnableIpv6:        pulumi.Bool(true),
			Hostname:          pulumi.String("my-instance-hostname"),
			Label:             pulumi.String("my-instance-label"),
			OsId:              pulumi.Int(1743),
			Plan:              pulumi.String("vc2-1c-2gb"),
			Region:            pulumi.String("sea"),
			Tags: pulumi.StringArray{
				pulumi.String("my-instance-tag"),
			},
		})
		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.vultr.Instance;
import com.pulumi.vultr.InstanceArgs;
import com.pulumi.vultr.inputs.InstanceBackupsScheduleArgs;
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 myInstance = new Instance("myInstance", InstanceArgs.builder()        
            .activationEmail(false)
            .backups("enabled")
            .backupsSchedule(InstanceBackupsScheduleArgs.builder()
                .type("daily")
                .build())
            .ddosProtection(true)
            .disablePublicIpv4(true)
            .enableIpv6(true)
            .hostname("my-instance-hostname")
            .label("my-instance-label")
            .osId(1743)
            .plan("vc2-1c-2gb")
            .region("sea")
            .tags("my-instance-tag")
            .build());

    }
}

    import pulumi
import ediri_vultr as vultr

my_instance = vultr.Instance("myInstance",
    activation_email=False,
    backups="enabled",
    backups_schedule=vultr.InstanceBackupsScheduleArgs(
        type="daily",
    ),
    ddos_protection=True,
    disable_public_ipv4=True,
    enable_ipv6=True,
    hostname="my-instance-hostname",
    label="my-instance-label",
    os_id=1743,
    plan="vc2-1c-2gb",
    region="sea",
    tags=["my-instance-tag"])

    import * as pulumi from "@pulumi/pulumi";
import * as vultr from "@ediri/vultr";

const myInstance = new vultr.Instance("myInstance", {
    activationEmail: false,
    backups: "enabled",
    backupsSchedule: {
        type: "daily",
    },
    ddosProtection: true,
    disablePublicIpv4: true,
    enableIpv6: true,
    hostname: "my-instance-hostname",
    label: "my-instance-label",
    osId: 1743,
    plan: "vc2-1c-2gb",
    region: "sea",
    tags: ["my-instance-tag"],
});

    resources:
  myInstance:
    type: vultr:Instance
    properties:
      activationEmail: false
      backups: enabled
      backupsSchedule:
        type: daily
      ddosProtection: true
      disablePublicIpv4: true
      enableIpv6: true
      hostname: my-instance-hostname
      label: my-instance-label
      osId: 1743
      plan: vc2-1c-2gb
      region: sea
      tags:
        - my-instance-tag

    Create Instance Resource

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

    Constructor syntax

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             plan: Optional[str] = None,
             region: Optional[str] = None,
             label: Optional[str] = None,
             vpc_ids: Optional[Sequence[str]] = None,
             activation_email: Optional[bool] = None,
             ddos_protection: Optional[bool] = None,
             disable_public_ipv4: Optional[bool] = None,
             enable_ipv6: Optional[bool] = None,
             firewall_group_id: Optional[str] = None,
             hostname: Optional[str] = None,
             image_id: Optional[str] = None,
             app_variables: Optional[Mapping[str, str]] = None,
             backups_schedule: Optional[InstanceBackupsScheduleArgs] = None,
             backups: Optional[str] = None,
             iso_id: Optional[str] = None,
             private_network_ids: Optional[Sequence[str]] = None,
             app_id: Optional[int] = None,
             reserved_ip_id: Optional[str] = None,
             script_id: Optional[str] = None,
             snapshot_id: Optional[str] = None,
             ssh_key_ids: Optional[Sequence[str]] = None,
             tags: Optional[Sequence[str]] = None,
             user_data: Optional[str] = None,
             vpc2_ids: Optional[Sequence[str]] = None,
             os_id: Optional[int] = None)
    func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)
    public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)
    public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

    type: vultr:Instance
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 InstanceArgs
    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 InstanceArgs
    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 InstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InstanceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var instanceResource = new Vultr.Instance("instanceResource", new()
{
    Plan = "string",
    Region = "string",
    Label = "string",
    VpcIds = new[]
    {
        "string",
    },
    ActivationEmail = false,
    DdosProtection = false,
    DisablePublicIpv4 = false,
    EnableIpv6 = false,
    FirewallGroupId = "string",
    Hostname = "string",
    ImageId = "string",
    AppVariables = 
    {
        { "string", "string" },
    },
    BackupsSchedule = new Vultr.Inputs.InstanceBackupsScheduleArgs
    {
        Type = "string",
        Dom = 0,
        Dow = 0,
        Hour = 0,
    },
    Backups = "string",
    IsoId = "string",
    AppId = 0,
    ReservedIpId = "string",
    ScriptId = "string",
    SnapshotId = "string",
    SshKeyIds = new[]
    {
        "string",
    },
    Tags = new[]
    {
        "string",
    },
    UserData = "string",
    Vpc2Ids = new[]
    {
        "string",
    },
    OsId = 0,
});

    example, err := vultr.NewInstance(ctx, "instanceResource", &vultr.InstanceArgs{
	Plan:   pulumi.String("string"),
	Region: pulumi.String("string"),
	Label:  pulumi.String("string"),
	VpcIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ActivationEmail:   pulumi.Bool(false),
	DdosProtection:    pulumi.Bool(false),
	DisablePublicIpv4: pulumi.Bool(false),
	EnableIpv6:        pulumi.Bool(false),
	FirewallGroupId:   pulumi.String("string"),
	Hostname:          pulumi.String("string"),
	ImageId:           pulumi.String("string"),
	AppVariables: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BackupsSchedule: &vultr.InstanceBackupsScheduleArgs{
		Type: pulumi.String("string"),
		Dom:  pulumi.Int(0),
		Dow:  pulumi.Int(0),
		Hour: pulumi.Int(0),
	},
	Backups:      pulumi.String("string"),
	IsoId:        pulumi.String("string"),
	AppId:        pulumi.Int(0),
	ReservedIpId: pulumi.String("string"),
	ScriptId:     pulumi.String("string"),
	SnapshotId:   pulumi.String("string"),
	SshKeyIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UserData: pulumi.String("string"),
	Vpc2Ids: pulumi.StringArray{
		pulumi.String("string"),
	},
	OsId: pulumi.Int(0),
})

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()        
    .plan("string")
    .region("string")
    .label("string")
    .vpcIds("string")
    .activationEmail(false)
    .ddosProtection(false)
    .disablePublicIpv4(false)
    .enableIpv6(false)
    .firewallGroupId("string")
    .hostname("string")
    .imageId("string")
    .appVariables(Map.of("string", "string"))
    .backupsSchedule(InstanceBackupsScheduleArgs.builder()
        .type("string")
        .dom(0)
        .dow(0)
        .hour(0)
        .build())
    .backups("string")
    .isoId("string")
    .appId(0)
    .reservedIpId("string")
    .scriptId("string")
    .snapshotId("string")
    .sshKeyIds("string")
    .tags("string")
    .userData("string")
    .vpc2Ids("string")
    .osId(0)
    .build());

    instance_resource = vultr.Instance("instanceResource",
    plan="string",
    region="string",
    label="string",
    vpc_ids=["string"],
    activation_email=False,
    ddos_protection=False,
    disable_public_ipv4=False,
    enable_ipv6=False,
    firewall_group_id="string",
    hostname="string",
    image_id="string",
    app_variables={
        "string": "string",
    },
    backups_schedule=vultr.InstanceBackupsScheduleArgs(
        type="string",
        dom=0,
        dow=0,
        hour=0,
    ),
    backups="string",
    iso_id="string",
    app_id=0,
    reserved_ip_id="string",
    script_id="string",
    snapshot_id="string",
    ssh_key_ids=["string"],
    tags=["string"],
    user_data="string",
    vpc2_ids=["string"],
    os_id=0)

    const instanceResource = new vultr.Instance("instanceResource", {
    plan: "string",
    region: "string",
    label: "string",
    vpcIds: ["string"],
    activationEmail: false,
    ddosProtection: false,
    disablePublicIpv4: false,
    enableIpv6: false,
    firewallGroupId: "string",
    hostname: "string",
    imageId: "string",
    appVariables: {
        string: "string",
    },
    backupsSchedule: {
        type: "string",
        dom: 0,
        dow: 0,
        hour: 0,
    },
    backups: "string",
    isoId: "string",
    appId: 0,
    reservedIpId: "string",
    scriptId: "string",
    snapshotId: "string",
    sshKeyIds: ["string"],
    tags: ["string"],
    userData: "string",
    vpc2Ids: ["string"],
    osId: 0,
});

    type: vultr:Instance
properties:
    activationEmail: false
    appId: 0
    appVariables:
        string: string
    backups: string
    backupsSchedule:
        dom: 0
        dow: 0
        hour: 0
        type: string
    ddosProtection: false
    disablePublicIpv4: false
    enableIpv6: false
    firewallGroupId: string
    hostname: string
    imageId: string
    isoId: string
    label: string
    osId: 0
    plan: string
    region: string
    reservedIpId: string
    scriptId: string
    snapshotId: string
    sshKeyIds:
        - string
    tags:
        - string
    userData: string
    vpc2Ids:
        - string
    vpcIds:
        - string

    Instance Resource Properties

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

    Inputs

    The Instance resource accepts the following input properties:

    Plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    Region string
    The ID of the region that the instance is to be created in. See List Regions
    ActivationEmail bool
    Whether an activation email will be sent when the server is ready.
    AppId int
    The ID of the Vultr application to be installed on the server. See List Applications
    AppVariables Dictionary<string, string>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    Backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    BackupsSchedule ediri.Vultr.Inputs.InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    DdosProtection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    DisablePublicIpv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    EnableIpv6 bool
    Whether the server has IPv6 networking activated.
    FirewallGroupId string
    The ID of the firewall group to assign to the server.
    Hostname string
    The hostname to assign to the server.
    ImageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    IsoId string
    The ID of the ISO file to be installed on the server. See List ISO
    Label string
    A label for the server.
    OsId int
    The ID of the operating system to be installed on the server. See List OS
    PrivateNetworkIds List<string>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ReservedIpId string
    ID of the floating IP to use as the main IP of this server.
    ScriptId string
    The ID of the startup script you want added to the server.
    SnapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    SshKeyIds List<string>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    Tags List<string>
    A list of tags to apply to the instance.
    UserData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    Vpc2Ids List<string>
    A list of VPC 2.0 IDs to be attached to the server.
    VpcIds List<string>
    A list of VPC IDs to be attached to the server.
    Plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    Region string
    The ID of the region that the instance is to be created in. See List Regions
    ActivationEmail bool
    Whether an activation email will be sent when the server is ready.
    AppId int
    The ID of the Vultr application to be installed on the server. See List Applications
    AppVariables map[string]string
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    Backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    BackupsSchedule InstanceBackupsScheduleArgs
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    DdosProtection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    DisablePublicIpv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    EnableIpv6 bool
    Whether the server has IPv6 networking activated.
    FirewallGroupId string
    The ID of the firewall group to assign to the server.
    Hostname string
    The hostname to assign to the server.
    ImageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    IsoId string
    The ID of the ISO file to be installed on the server. See List ISO
    Label string
    A label for the server.
    OsId int
    The ID of the operating system to be installed on the server. See List OS
    PrivateNetworkIds []string
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ReservedIpId string
    ID of the floating IP to use as the main IP of this server.
    ScriptId string
    The ID of the startup script you want added to the server.
    SnapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    SshKeyIds []string
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    Tags []string
    A list of tags to apply to the instance.
    UserData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    Vpc2Ids []string
    A list of VPC 2.0 IDs to be attached to the server.
    VpcIds []string
    A list of VPC IDs to be attached to the server.
    plan String
    The ID of the plan that you want the instance to subscribe to. See List Plans
    region String
    The ID of the region that the instance is to be created in. See List Regions
    activationEmail Boolean
    Whether an activation email will be sent when the server is ready.
    appId Integer
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables Map<String,String>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups String
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    ddosProtection Boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    disablePublicIpv4 Boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    enableIpv6 Boolean
    Whether the server has IPv6 networking activated.
    firewallGroupId String
    The ID of the firewall group to assign to the server.
    hostname String
    The hostname to assign to the server.
    imageId String
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    isoId String
    The ID of the ISO file to be installed on the server. See List ISO
    label String
    A label for the server.
    osId Integer
    The ID of the operating system to be installed on the server. See List OS
    privateNetworkIds List<String>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    reservedIpId String
    ID of the floating IP to use as the main IP of this server.
    scriptId String
    The ID of the startup script you want added to the server.
    snapshotId String
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds List<String>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    tags List<String>
    A list of tags to apply to the instance.
    userData String
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    vpc2Ids List<String>
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds List<String>
    A list of VPC IDs to be attached to the server.
    plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    region string
    The ID of the region that the instance is to be created in. See List Regions
    activationEmail boolean
    Whether an activation email will be sent when the server is ready.
    appId number
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables {[key: string]: string}
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    ddosProtection boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    disablePublicIpv4 boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    enableIpv6 boolean
    Whether the server has IPv6 networking activated.
    firewallGroupId string
    The ID of the firewall group to assign to the server.
    hostname string
    The hostname to assign to the server.
    imageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    isoId string
    The ID of the ISO file to be installed on the server. See List ISO
    label string
    A label for the server.
    osId number
    The ID of the operating system to be installed on the server. See List OS
    privateNetworkIds string[]
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    reservedIpId string
    ID of the floating IP to use as the main IP of this server.
    scriptId string
    The ID of the startup script you want added to the server.
    snapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds string[]
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    tags string[]
    A list of tags to apply to the instance.
    userData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    vpc2Ids string[]
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds string[]
    A list of VPC IDs to be attached to the server.
    plan str
    The ID of the plan that you want the instance to subscribe to. See List Plans
    region str
    The ID of the region that the instance is to be created in. See List Regions
    activation_email bool
    Whether an activation email will be sent when the server is ready.
    app_id int
    The ID of the Vultr application to be installed on the server. See List Applications
    app_variables Mapping[str, str]
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups str
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backups_schedule InstanceBackupsScheduleArgs
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    ddos_protection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    disable_public_ipv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    enable_ipv6 bool
    Whether the server has IPv6 networking activated.
    firewall_group_id str
    The ID of the firewall group to assign to the server.
    hostname str
    The hostname to assign to the server.
    image_id str
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    iso_id str
    The ID of the ISO file to be installed on the server. See List ISO
    label str
    A label for the server.
    os_id int
    The ID of the operating system to be installed on the server. See List OS
    private_network_ids Sequence[str]
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    reserved_ip_id str
    ID of the floating IP to use as the main IP of this server.
    script_id str
    The ID of the startup script you want added to the server.
    snapshot_id str
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    ssh_key_ids Sequence[str]
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    tags Sequence[str]
    A list of tags to apply to the instance.
    user_data str
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    vpc2_ids Sequence[str]
    A list of VPC 2.0 IDs to be attached to the server.
    vpc_ids Sequence[str]
    A list of VPC IDs to be attached to the server.
    plan String
    The ID of the plan that you want the instance to subscribe to. See List Plans
    region String
    The ID of the region that the instance is to be created in. See List Regions
    activationEmail Boolean
    Whether an activation email will be sent when the server is ready.
    appId Number
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables Map<String>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups String
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule Property Map
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    ddosProtection Boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    disablePublicIpv4 Boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    enableIpv6 Boolean
    Whether the server has IPv6 networking activated.
    firewallGroupId String
    The ID of the firewall group to assign to the server.
    hostname String
    The hostname to assign to the server.
    imageId String
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    isoId String
    The ID of the ISO file to be installed on the server. See List ISO
    label String
    A label for the server.
    osId Number
    The ID of the operating system to be installed on the server. See List OS
    privateNetworkIds List<String>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    reservedIpId String
    ID of the floating IP to use as the main IP of this server.
    scriptId String
    The ID of the startup script you want added to the server.
    snapshotId String
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds List<String>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    tags List<String>
    A list of tags to apply to the instance.
    userData String
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    vpc2Ids List<String>
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds List<String>
    A list of VPC IDs to be attached to the server.

    Outputs

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

    AllowedBandwidth int
    The server's allowed bandwidth usage in GB.
    DateCreated string
    The date the server was added to your Vultr account.
    DefaultPassword string
    The server's default password.
    Disk int
    The description of the disk(s) on the server.
    Features List<string>
    Array of which features are enabled.
    GatewayV4 string
    The server's IPv4 gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalIp string
    The server's internal IP address.
    Kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    MainIp string
    The server's main IP address.
    NetmaskV4 string
    The server's IPv4 netmask.
    Os string
    The string description of the operating system installed on the server.
    PowerStatus string
    Whether the server is powered on or not.
    Ram int
    The amount of memory available on the server in MB.
    ServerStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    Status string
    The status of the server's subscription.
    V6MainIp string
    The main IPv6 network address.
    V6Network string
    The IPv6 subnet.
    V6NetworkSize int
    The IPv6 network size in bits.
    VcpuCount int
    The number of virtual CPUs available on the server.
    AllowedBandwidth int
    The server's allowed bandwidth usage in GB.
    DateCreated string
    The date the server was added to your Vultr account.
    DefaultPassword string
    The server's default password.
    Disk int
    The description of the disk(s) on the server.
    Features []string
    Array of which features are enabled.
    GatewayV4 string
    The server's IPv4 gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    InternalIp string
    The server's internal IP address.
    Kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    MainIp string
    The server's main IP address.
    NetmaskV4 string
    The server's IPv4 netmask.
    Os string
    The string description of the operating system installed on the server.
    PowerStatus string
    Whether the server is powered on or not.
    Ram int
    The amount of memory available on the server in MB.
    ServerStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    Status string
    The status of the server's subscription.
    V6MainIp string
    The main IPv6 network address.
    V6Network string
    The IPv6 subnet.
    V6NetworkSize int
    The IPv6 network size in bits.
    VcpuCount int
    The number of virtual CPUs available on the server.
    allowedBandwidth Integer
    The server's allowed bandwidth usage in GB.
    dateCreated String
    The date the server was added to your Vultr account.
    defaultPassword String
    The server's default password.
    disk Integer
    The description of the disk(s) on the server.
    features List<String>
    Array of which features are enabled.
    gatewayV4 String
    The server's IPv4 gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    internalIp String
    The server's internal IP address.
    kvm String
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    mainIp String
    The server's main IP address.
    netmaskV4 String
    The server's IPv4 netmask.
    os String
    The string description of the operating system installed on the server.
    powerStatus String
    Whether the server is powered on or not.
    ram Integer
    The amount of memory available on the server in MB.
    serverStatus String
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    status String
    The status of the server's subscription.
    v6MainIp String
    The main IPv6 network address.
    v6Network String
    The IPv6 subnet.
    v6NetworkSize Integer
    The IPv6 network size in bits.
    vcpuCount Integer
    The number of virtual CPUs available on the server.
    allowedBandwidth number
    The server's allowed bandwidth usage in GB.
    dateCreated string
    The date the server was added to your Vultr account.
    defaultPassword string
    The server's default password.
    disk number
    The description of the disk(s) on the server.
    features string[]
    Array of which features are enabled.
    gatewayV4 string
    The server's IPv4 gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    internalIp string
    The server's internal IP address.
    kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    mainIp string
    The server's main IP address.
    netmaskV4 string
    The server's IPv4 netmask.
    os string
    The string description of the operating system installed on the server.
    powerStatus string
    Whether the server is powered on or not.
    ram number
    The amount of memory available on the server in MB.
    serverStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    status string
    The status of the server's subscription.
    v6MainIp string
    The main IPv6 network address.
    v6Network string
    The IPv6 subnet.
    v6NetworkSize number
    The IPv6 network size in bits.
    vcpuCount number
    The number of virtual CPUs available on the server.
    allowed_bandwidth int
    The server's allowed bandwidth usage in GB.
    date_created str
    The date the server was added to your Vultr account.
    default_password str
    The server's default password.
    disk int
    The description of the disk(s) on the server.
    features Sequence[str]
    Array of which features are enabled.
    gateway_v4 str
    The server's IPv4 gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    internal_ip str
    The server's internal IP address.
    kvm str
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    main_ip str
    The server's main IP address.
    netmask_v4 str
    The server's IPv4 netmask.
    os str
    The string description of the operating system installed on the server.
    power_status str
    Whether the server is powered on or not.
    ram int
    The amount of memory available on the server in MB.
    server_status str
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    status str
    The status of the server's subscription.
    v6_main_ip str
    The main IPv6 network address.
    v6_network str
    The IPv6 subnet.
    v6_network_size int
    The IPv6 network size in bits.
    vcpu_count int
    The number of virtual CPUs available on the server.
    allowedBandwidth Number
    The server's allowed bandwidth usage in GB.
    dateCreated String
    The date the server was added to your Vultr account.
    defaultPassword String
    The server's default password.
    disk Number
    The description of the disk(s) on the server.
    features List<String>
    Array of which features are enabled.
    gatewayV4 String
    The server's IPv4 gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    internalIp String
    The server's internal IP address.
    kvm String
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    mainIp String
    The server's main IP address.
    netmaskV4 String
    The server's IPv4 netmask.
    os String
    The string description of the operating system installed on the server.
    powerStatus String
    Whether the server is powered on or not.
    ram Number
    The amount of memory available on the server in MB.
    serverStatus String
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    status String
    The status of the server's subscription.
    v6MainIp String
    The main IPv6 network address.
    v6Network String
    The IPv6 subnet.
    v6NetworkSize Number
    The IPv6 network size in bits.
    vcpuCount Number
    The number of virtual CPUs available on the server.

    Look up Existing Instance Resource

    Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        activation_email: Optional[bool] = None,
        allowed_bandwidth: Optional[int] = None,
        app_id: Optional[int] = None,
        app_variables: Optional[Mapping[str, str]] = None,
        backups: Optional[str] = None,
        backups_schedule: Optional[InstanceBackupsScheduleArgs] = None,
        date_created: Optional[str] = None,
        ddos_protection: Optional[bool] = None,
        default_password: Optional[str] = None,
        disable_public_ipv4: Optional[bool] = None,
        disk: Optional[int] = None,
        enable_ipv6: Optional[bool] = None,
        features: Optional[Sequence[str]] = None,
        firewall_group_id: Optional[str] = None,
        gateway_v4: Optional[str] = None,
        hostname: Optional[str] = None,
        image_id: Optional[str] = None,
        internal_ip: Optional[str] = None,
        iso_id: Optional[str] = None,
        kvm: Optional[str] = None,
        label: Optional[str] = None,
        main_ip: Optional[str] = None,
        netmask_v4: Optional[str] = None,
        os: Optional[str] = None,
        os_id: Optional[int] = None,
        plan: Optional[str] = None,
        power_status: Optional[str] = None,
        private_network_ids: Optional[Sequence[str]] = None,
        ram: Optional[int] = None,
        region: Optional[str] = None,
        reserved_ip_id: Optional[str] = None,
        script_id: Optional[str] = None,
        server_status: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        ssh_key_ids: Optional[Sequence[str]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        user_data: Optional[str] = None,
        v6_main_ip: Optional[str] = None,
        v6_network: Optional[str] = None,
        v6_network_size: Optional[int] = None,
        vcpu_count: Optional[int] = None,
        vpc2_ids: Optional[Sequence[str]] = None,
        vpc_ids: Optional[Sequence[str]] = None) -> Instance
    func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)
    public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)
    public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ActivationEmail bool
    Whether an activation email will be sent when the server is ready.
    AllowedBandwidth int
    The server's allowed bandwidth usage in GB.
    AppId int
    The ID of the Vultr application to be installed on the server. See List Applications
    AppVariables Dictionary<string, string>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    Backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    BackupsSchedule ediri.Vultr.Inputs.InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    DateCreated string
    The date the server was added to your Vultr account.
    DdosProtection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    DefaultPassword string
    The server's default password.
    DisablePublicIpv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    Disk int
    The description of the disk(s) on the server.
    EnableIpv6 bool
    Whether the server has IPv6 networking activated.
    Features List<string>
    Array of which features are enabled.
    FirewallGroupId string
    The ID of the firewall group to assign to the server.
    GatewayV4 string
    The server's IPv4 gateway.
    Hostname string
    The hostname to assign to the server.
    ImageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    InternalIp string
    The server's internal IP address.
    IsoId string
    The ID of the ISO file to be installed on the server. See List ISO
    Kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    Label string
    A label for the server.
    MainIp string
    The server's main IP address.
    NetmaskV4 string
    The server's IPv4 netmask.
    Os string
    The string description of the operating system installed on the server.
    OsId int
    The ID of the operating system to be installed on the server. See List OS
    Plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    PowerStatus string
    Whether the server is powered on or not.
    PrivateNetworkIds List<string>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    Ram int
    The amount of memory available on the server in MB.
    Region string
    The ID of the region that the instance is to be created in. See List Regions
    ReservedIpId string
    ID of the floating IP to use as the main IP of this server.
    ScriptId string
    The ID of the startup script you want added to the server.
    ServerStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    SnapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    SshKeyIds List<string>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    Status string
    The status of the server's subscription.
    Tags List<string>
    A list of tags to apply to the instance.
    UserData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    V6MainIp string
    The main IPv6 network address.
    V6Network string
    The IPv6 subnet.
    V6NetworkSize int
    The IPv6 network size in bits.
    VcpuCount int
    The number of virtual CPUs available on the server.
    Vpc2Ids List<string>
    A list of VPC 2.0 IDs to be attached to the server.
    VpcIds List<string>
    A list of VPC IDs to be attached to the server.
    ActivationEmail bool
    Whether an activation email will be sent when the server is ready.
    AllowedBandwidth int
    The server's allowed bandwidth usage in GB.
    AppId int
    The ID of the Vultr application to be installed on the server. See List Applications
    AppVariables map[string]string
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    Backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    BackupsSchedule InstanceBackupsScheduleArgs
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    DateCreated string
    The date the server was added to your Vultr account.
    DdosProtection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    DefaultPassword string
    The server's default password.
    DisablePublicIpv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    Disk int
    The description of the disk(s) on the server.
    EnableIpv6 bool
    Whether the server has IPv6 networking activated.
    Features []string
    Array of which features are enabled.
    FirewallGroupId string
    The ID of the firewall group to assign to the server.
    GatewayV4 string
    The server's IPv4 gateway.
    Hostname string
    The hostname to assign to the server.
    ImageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    InternalIp string
    The server's internal IP address.
    IsoId string
    The ID of the ISO file to be installed on the server. See List ISO
    Kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    Label string
    A label for the server.
    MainIp string
    The server's main IP address.
    NetmaskV4 string
    The server's IPv4 netmask.
    Os string
    The string description of the operating system installed on the server.
    OsId int
    The ID of the operating system to be installed on the server. See List OS
    Plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    PowerStatus string
    Whether the server is powered on or not.
    PrivateNetworkIds []string
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    Ram int
    The amount of memory available on the server in MB.
    Region string
    The ID of the region that the instance is to be created in. See List Regions
    ReservedIpId string
    ID of the floating IP to use as the main IP of this server.
    ScriptId string
    The ID of the startup script you want added to the server.
    ServerStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    SnapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    SshKeyIds []string
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    Status string
    The status of the server's subscription.
    Tags []string
    A list of tags to apply to the instance.
    UserData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    V6MainIp string
    The main IPv6 network address.
    V6Network string
    The IPv6 subnet.
    V6NetworkSize int
    The IPv6 network size in bits.
    VcpuCount int
    The number of virtual CPUs available on the server.
    Vpc2Ids []string
    A list of VPC 2.0 IDs to be attached to the server.
    VpcIds []string
    A list of VPC IDs to be attached to the server.
    activationEmail Boolean
    Whether an activation email will be sent when the server is ready.
    allowedBandwidth Integer
    The server's allowed bandwidth usage in GB.
    appId Integer
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables Map<String,String>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups String
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    dateCreated String
    The date the server was added to your Vultr account.
    ddosProtection Boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    defaultPassword String
    The server's default password.
    disablePublicIpv4 Boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    disk Integer
    The description of the disk(s) on the server.
    enableIpv6 Boolean
    Whether the server has IPv6 networking activated.
    features List<String>
    Array of which features are enabled.
    firewallGroupId String
    The ID of the firewall group to assign to the server.
    gatewayV4 String
    The server's IPv4 gateway.
    hostname String
    The hostname to assign to the server.
    imageId String
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    internalIp String
    The server's internal IP address.
    isoId String
    The ID of the ISO file to be installed on the server. See List ISO
    kvm String
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    label String
    A label for the server.
    mainIp String
    The server's main IP address.
    netmaskV4 String
    The server's IPv4 netmask.
    os String
    The string description of the operating system installed on the server.
    osId Integer
    The ID of the operating system to be installed on the server. See List OS
    plan String
    The ID of the plan that you want the instance to subscribe to. See List Plans
    powerStatus String
    Whether the server is powered on or not.
    privateNetworkIds List<String>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ram Integer
    The amount of memory available on the server in MB.
    region String
    The ID of the region that the instance is to be created in. See List Regions
    reservedIpId String
    ID of the floating IP to use as the main IP of this server.
    scriptId String
    The ID of the startup script you want added to the server.
    serverStatus String
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    snapshotId String
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds List<String>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    status String
    The status of the server's subscription.
    tags List<String>
    A list of tags to apply to the instance.
    userData String
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    v6MainIp String
    The main IPv6 network address.
    v6Network String
    The IPv6 subnet.
    v6NetworkSize Integer
    The IPv6 network size in bits.
    vcpuCount Integer
    The number of virtual CPUs available on the server.
    vpc2Ids List<String>
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds List<String>
    A list of VPC IDs to be attached to the server.
    activationEmail boolean
    Whether an activation email will be sent when the server is ready.
    allowedBandwidth number
    The server's allowed bandwidth usage in GB.
    appId number
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables {[key: string]: string}
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups string
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule InstanceBackupsSchedule
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    dateCreated string
    The date the server was added to your Vultr account.
    ddosProtection boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    defaultPassword string
    The server's default password.
    disablePublicIpv4 boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    disk number
    The description of the disk(s) on the server.
    enableIpv6 boolean
    Whether the server has IPv6 networking activated.
    features string[]
    Array of which features are enabled.
    firewallGroupId string
    The ID of the firewall group to assign to the server.
    gatewayV4 string
    The server's IPv4 gateway.
    hostname string
    The hostname to assign to the server.
    imageId string
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    internalIp string
    The server's internal IP address.
    isoId string
    The ID of the ISO file to be installed on the server. See List ISO
    kvm string
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    label string
    A label for the server.
    mainIp string
    The server's main IP address.
    netmaskV4 string
    The server's IPv4 netmask.
    os string
    The string description of the operating system installed on the server.
    osId number
    The ID of the operating system to be installed on the server. See List OS
    plan string
    The ID of the plan that you want the instance to subscribe to. See List Plans
    powerStatus string
    Whether the server is powered on or not.
    privateNetworkIds string[]
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ram number
    The amount of memory available on the server in MB.
    region string
    The ID of the region that the instance is to be created in. See List Regions
    reservedIpId string
    ID of the floating IP to use as the main IP of this server.
    scriptId string
    The ID of the startup script you want added to the server.
    serverStatus string
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    snapshotId string
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds string[]
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    status string
    The status of the server's subscription.
    tags string[]
    A list of tags to apply to the instance.
    userData string
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    v6MainIp string
    The main IPv6 network address.
    v6Network string
    The IPv6 subnet.
    v6NetworkSize number
    The IPv6 network size in bits.
    vcpuCount number
    The number of virtual CPUs available on the server.
    vpc2Ids string[]
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds string[]
    A list of VPC IDs to be attached to the server.
    activation_email bool
    Whether an activation email will be sent when the server is ready.
    allowed_bandwidth int
    The server's allowed bandwidth usage in GB.
    app_id int
    The ID of the Vultr application to be installed on the server. See List Applications
    app_variables Mapping[str, str]
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups str
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backups_schedule InstanceBackupsScheduleArgs
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    date_created str
    The date the server was added to your Vultr account.
    ddos_protection bool
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    default_password str
    The server's default password.
    disable_public_ipv4 bool
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    disk int
    The description of the disk(s) on the server.
    enable_ipv6 bool
    Whether the server has IPv6 networking activated.
    features Sequence[str]
    Array of which features are enabled.
    firewall_group_id str
    The ID of the firewall group to assign to the server.
    gateway_v4 str
    The server's IPv4 gateway.
    hostname str
    The hostname to assign to the server.
    image_id str
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    internal_ip str
    The server's internal IP address.
    iso_id str
    The ID of the ISO file to be installed on the server. See List ISO
    kvm str
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    label str
    A label for the server.
    main_ip str
    The server's main IP address.
    netmask_v4 str
    The server's IPv4 netmask.
    os str
    The string description of the operating system installed on the server.
    os_id int
    The ID of the operating system to be installed on the server. See List OS
    plan str
    The ID of the plan that you want the instance to subscribe to. See List Plans
    power_status str
    Whether the server is powered on or not.
    private_network_ids Sequence[str]
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ram int
    The amount of memory available on the server in MB.
    region str
    The ID of the region that the instance is to be created in. See List Regions
    reserved_ip_id str
    ID of the floating IP to use as the main IP of this server.
    script_id str
    The ID of the startup script you want added to the server.
    server_status str
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    snapshot_id str
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    ssh_key_ids Sequence[str]
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    status str
    The status of the server's subscription.
    tags Sequence[str]
    A list of tags to apply to the instance.
    user_data str
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    v6_main_ip str
    The main IPv6 network address.
    v6_network str
    The IPv6 subnet.
    v6_network_size int
    The IPv6 network size in bits.
    vcpu_count int
    The number of virtual CPUs available on the server.
    vpc2_ids Sequence[str]
    A list of VPC 2.0 IDs to be attached to the server.
    vpc_ids Sequence[str]
    A list of VPC IDs to be attached to the server.
    activationEmail Boolean
    Whether an activation email will be sent when the server is ready.
    allowedBandwidth Number
    The server's allowed bandwidth usage in GB.
    appId Number
    The ID of the Vultr application to be installed on the server. See List Applications
    appVariables Map<String>
    A map of user-supplied variable keys and values for Vultr Marketplace apps. See List Marketplace App Variables
    backups String
    Whether automatic backups will be enabled for this server (these have an extra charge associated with them). Values can be enabled or disabled.
    backupsSchedule Property Map
    A block that defines the way backups should be scheduled. While this is an optional field if backups are enabled this field is mandatory. The configuration of a backups_schedule is listed below.
    dateCreated String
    The date the server was added to your Vultr account.
    ddosProtection Boolean
    Whether DDOS protection will be enabled on the server (there is an additional charge for this).
    defaultPassword String
    The server's default password.
    disablePublicIpv4 Boolean
    Whether the server has a public IPv4 address assigned (only possible with enable_ipv6 set to true)
    disk Number
    The description of the disk(s) on the server.
    enableIpv6 Boolean
    Whether the server has IPv6 networking activated.
    features List<String>
    Array of which features are enabled.
    firewallGroupId String
    The ID of the firewall group to assign to the server.
    gatewayV4 String
    The server's IPv4 gateway.
    hostname String
    The hostname to assign to the server.
    imageId String
    The ID of the Vultr marketplace application to be installed on the server. See List Applications Note marketplace applications are denoted by type: marketplace and you must use the image_id not the id.
    internalIp String
    The server's internal IP address.
    isoId String
    The ID of the ISO file to be installed on the server. See List ISO
    kvm String
    The server's current KVM URL. This URL will change periodically. It is not advised to cache this value.
    label String
    A label for the server.
    mainIp String
    The server's main IP address.
    netmaskV4 String
    The server's IPv4 netmask.
    os String
    The string description of the operating system installed on the server.
    osId Number
    The ID of the operating system to be installed on the server. See List OS
    plan String
    The ID of the plan that you want the instance to subscribe to. See List Plans
    powerStatus String
    Whether the server is powered on or not.
    privateNetworkIds List<String>
    (Deprecated: use vpc_ids instead) A list of private network IDs to be attached to the server.

    Deprecated: private_network_ids has been deprecated and should no longer be used. Instead, use vpc_ids

    ram Number
    The amount of memory available on the server in MB.
    region String
    The ID of the region that the instance is to be created in. See List Regions
    reservedIpId String
    ID of the floating IP to use as the main IP of this server.
    scriptId String
    The ID of the startup script you want added to the server.
    serverStatus String
    A more detailed server status (none, locked, installingbooting, isomounting, ok).
    snapshotId String
    The ID of the Vultr snapshot that the server will restore for the initial installation. See List Snapshots
    sshKeyIds List<String>
    A list of SSH key IDs to apply to the server on install (only valid for Linux/FreeBSD).
    status String
    The status of the server's subscription.
    tags List<String>
    A list of tags to apply to the instance.
    userData String
    Generic data store, which some provisioning tools and cloud operating systems use as a configuration file. It is generally consumed only once after an instance has been launched, but individual needs may vary.
    v6MainIp String
    The main IPv6 network address.
    v6Network String
    The IPv6 subnet.
    v6NetworkSize Number
    The IPv6 network size in bits.
    vcpuCount Number
    The number of virtual CPUs available on the server.
    vpc2Ids List<String>
    A list of VPC 2.0 IDs to be attached to the server.
    vpcIds List<String>
    A list of VPC IDs to be attached to the server.

    Supporting Types

    InstanceBackupsSchedule, InstanceBackupsScheduleArgs

    Type string
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    Dom int
    Day of month to run. Use values between 1 and 28.
    Dow int
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    Hour int
    Hour of day to run in UTC.
    Type string
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    Dom int
    Day of month to run. Use values between 1 and 28.
    Dow int
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    Hour int
    Hour of day to run in UTC.
    type String
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    dom Integer
    Day of month to run. Use values between 1 and 28.
    dow Integer
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    hour Integer
    Hour of day to run in UTC.
    type string
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    dom number
    Day of month to run. Use values between 1 and 28.
    dow number
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    hour number
    Hour of day to run in UTC.
    type str
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    dom int
    Day of month to run. Use values between 1 and 28.
    dow int
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    hour int
    Hour of day to run in UTC.
    type String
    Type of backup schedule Possible values are daily, weekly, monthly, daily_alt_even, or daily_alt_odd.
    dom Number
    Day of month to run. Use values between 1 and 28.
    dow Number
    Day of week to run. 1 = Sunday, 2 = Monday, 3 = Tuesday, 4 = Wednesday, 5 = Thursday, 6 = Friday, 7 = Saturday
    hour Number
    Hour of day to run in UTC.

    Import

    Instances can be imported using the instance ID, e.g.

     $ pulumi import vultr:index/instance:Instance my_instance b6a859c5-b299-49dd-8888-b1abbc517d08

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vultr dirien/pulumi-vultr
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vultr Terraform Provider.
    vultr logo
    Vultr v2.19.0 published on Friday, Jan 5, 2024 by dirien
    dirien/pulumi-vultr