Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. OVH
  3. API Docs
  4. CloudProject
  5. Instance
OVHCloud v2.2.3 published on Friday, Jun 6, 2025 by OVHcloud
ovh/pulumi-ovh

ovh.CloudProject.Instance

Explore with Pulumi AI

ovh logo
OVHCloud v2.2.3 published on Friday, Jun 6, 2025 by OVHcloud
ovh/pulumi-ovh

    This resource uses a Beta API Creates an instance associated with a public cloud project.

    Example Usage

    Create a instance.

    import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";

const instance = new ovh.cloudproject.Instance("instance", {
    serviceName: "XXX",
    region: "RRRR",
    billingPeriod: "hourly",
    bootFrom: {
        imageId: "UUID",
    },
    flavor: {
        flavorId: "UUID",
    },
    name: "instance name",
    sshKey: {
        name: "sshname",
    },
    network: {
        "public": true,
    },
});

    import pulumi
import pulumi_ovh as ovh

instance = ovh.cloud_project.Instance("instance",
    service_name="XXX",
    region="RRRR",
    billing_period="hourly",
    boot_from={
        "image_id": "UUID",
    },
    flavor={
        "flavor_id": "UUID",
    },
    name="instance name",
    ssh_key={
        "name": "sshname",
    },
    network={
        "public": True,
    })

    package main

import (
	"github.com/ovh/pulumi-ovh/sdk/v2/go/ovh/cloudproject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudproject.NewInstance(ctx, "instance", &cloudproject.InstanceArgs{
			ServiceName:   pulumi.String("XXX"),
			Region:        pulumi.String("RRRR"),
			BillingPeriod: pulumi.String("hourly"),
			BootFrom: &cloudproject.InstanceBootFromArgs{
				ImageId: pulumi.String("UUID"),
			},
			Flavor: &cloudproject.InstanceFlavorArgs{
				FlavorId: pulumi.String("UUID"),
			},
			Name: pulumi.String("instance name"),
			SshKey: &cloudproject.InstanceSshKeyArgs{
				Name: pulumi.String("sshname"),
			},
			Network: &cloudproject.InstanceNetworkArgs{
				Public: pulumi.Bool(true),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var instance = new Ovh.CloudProject.Instance("instance", new()
    {
        ServiceName = "XXX",
        Region = "RRRR",
        BillingPeriod = "hourly",
        BootFrom = new Ovh.CloudProject.Inputs.InstanceBootFromArgs
        {
            ImageId = "UUID",
        },
        Flavor = new Ovh.CloudProject.Inputs.InstanceFlavorArgs
        {
            FlavorId = "UUID",
        },
        Name = "instance name",
        SshKey = new Ovh.CloudProject.Inputs.InstanceSshKeyArgs
        {
            Name = "sshname",
        },
        Network = new Ovh.CloudProject.Inputs.InstanceNetworkArgs
        {
            Public = true,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.ovhcloud.pulumi.ovh.CloudProject.Instance;
import com.ovhcloud.pulumi.ovh.CloudProject.InstanceArgs;
import com.pulumi.ovh.CloudProject.inputs.InstanceBootFromArgs;
import com.pulumi.ovh.CloudProject.inputs.InstanceFlavorArgs;
import com.pulumi.ovh.CloudProject.inputs.InstanceSshKeyArgs;
import com.pulumi.ovh.CloudProject.inputs.InstanceNetworkArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .serviceName("XXX")
            .region("RRRR")
            .billingPeriod("hourly")
            .bootFrom(InstanceBootFromArgs.builder()
                .imageId("UUID")
                .build())
            .flavor(InstanceFlavorArgs.builder()
                .flavorId("UUID")
                .build())
            .name("instance name")
            .sshKey(InstanceSshKeyArgs.builder()
                .name("sshname")
                .build())
            .network(InstanceNetworkArgs.builder()
                .public_(true)
                .build())
            .build());

    }
}

    resources:
  instance:
    type: ovh:CloudProject:Instance
    properties:
      serviceName: XXX
      region: RRRR
      billingPeriod: hourly
      bootFrom:
        imageId: UUID
      flavor:
        flavorId: UUID
      name: instance name
      sshKey:
        name: sshname
      network:
        public: true

    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,
             region: Optional[str] = None,
             flavor: Optional[InstanceFlavorArgs] = None,
             billing_period: Optional[str] = None,
             boot_from: Optional[InstanceBootFromArgs] = None,
             network: Optional[InstanceNetworkArgs] = None,
             ssh_key_create: Optional[InstanceSshKeyCreateArgs] = None,
             bulk: Optional[int] = None,
             group: Optional[InstanceGroupArgs] = None,
             availability_zone: Optional[str] = None,
             auto_backup: Optional[InstanceAutoBackupArgs] = None,
             service_name: Optional[str] = None,
             ssh_key: Optional[InstanceSshKeyArgs] = None,
             name: Optional[str] = None,
             user_data: Optional[str] = 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: ovh:CloudProject: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.

    Constructor example

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

    var instanceResource = new Ovh.CloudProject.Instance("instanceResource", new()
{
    Region = "string",
    Flavor = new Ovh.CloudProject.Inputs.InstanceFlavorArgs
    {
        FlavorId = "string",
    },
    BillingPeriod = "string",
    BootFrom = new Ovh.CloudProject.Inputs.InstanceBootFromArgs
    {
        ImageId = "string",
        VolumeId = "string",
    },
    Network = new Ovh.CloudProject.Inputs.InstanceNetworkArgs
    {
        Private = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateArgs
        {
            FloatingIp = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateFloatingIpArgs
            {
                Id = "string",
            },
            FloatingIpCreate = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateFloatingIpCreateArgs
            {
                Description = "string",
            },
            Gateway = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateGatewayArgs
            {
                Id = "string",
            },
            GatewayCreate = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateGatewayCreateArgs
            {
                Model = "string",
                Name = "string",
            },
            Ip = "string",
            Network = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateNetworkArgs
            {
                Id = "string",
                SubnetId = "string",
            },
            NetworkCreate = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateNetworkCreateArgs
            {
                Name = "string",
                Subnet = new Ovh.CloudProject.Inputs.InstanceNetworkPrivateNetworkCreateSubnetArgs
                {
                    Cidr = "string",
                    EnableDhcp = false,
                    IpVersion = 0,
                },
                VlanId = 0,
            },
        },
        Public = false,
    },
    SshKeyCreate = new Ovh.CloudProject.Inputs.InstanceSshKeyCreateArgs
    {
        Name = "string",
        PublicKey = "string",
    },
    Bulk = 0,
    Group = new Ovh.CloudProject.Inputs.InstanceGroupArgs
    {
        GroupId = "string",
    },
    AvailabilityZone = "string",
    AutoBackup = new Ovh.CloudProject.Inputs.InstanceAutoBackupArgs
    {
        Cron = "string",
        Rotation = 0,
    },
    ServiceName = "string",
    SshKey = new Ovh.CloudProject.Inputs.InstanceSshKeyArgs
    {
        Name = "string",
    },
    Name = "string",
    UserData = "string",
});

    example, err := cloudproject.NewInstance(ctx, "instanceResource", &cloudproject.InstanceArgs{
	Region: pulumi.String("string"),
	Flavor: &cloudproject.InstanceFlavorArgs{
		FlavorId: pulumi.String("string"),
	},
	BillingPeriod: pulumi.String("string"),
	BootFrom: &cloudproject.InstanceBootFromArgs{
		ImageId:  pulumi.String("string"),
		VolumeId: pulumi.String("string"),
	},
	Network: &cloudproject.InstanceNetworkArgs{
		Private: &cloudproject.InstanceNetworkPrivateArgs{
			FloatingIp: &cloudproject.InstanceNetworkPrivateFloatingIpArgs{
				Id: pulumi.String("string"),
			},
			FloatingIpCreate: &cloudproject.InstanceNetworkPrivateFloatingIpCreateArgs{
				Description: pulumi.String("string"),
			},
			Gateway: &cloudproject.InstanceNetworkPrivateGatewayArgs{
				Id: pulumi.String("string"),
			},
			GatewayCreate: &cloudproject.InstanceNetworkPrivateGatewayCreateArgs{
				Model: pulumi.String("string"),
				Name:  pulumi.String("string"),
			},
			Ip: pulumi.String("string"),
			Network: &cloudproject.InstanceNetworkPrivateNetworkArgs{
				Id:       pulumi.String("string"),
				SubnetId: pulumi.String("string"),
			},
			NetworkCreate: &cloudproject.InstanceNetworkPrivateNetworkCreateArgs{
				Name: pulumi.String("string"),
				Subnet: &cloudproject.InstanceNetworkPrivateNetworkCreateSubnetArgs{
					Cidr:       pulumi.String("string"),
					EnableDhcp: pulumi.Bool(false),
					IpVersion:  pulumi.Int(0),
				},
				VlanId: pulumi.Int(0),
			},
		},
		Public: pulumi.Bool(false),
	},
	SshKeyCreate: &cloudproject.InstanceSshKeyCreateArgs{
		Name:      pulumi.String("string"),
		PublicKey: pulumi.String("string"),
	},
	Bulk: pulumi.Int(0),
	Group: &cloudproject.InstanceGroupArgs{
		GroupId: pulumi.String("string"),
	},
	AvailabilityZone: pulumi.String("string"),
	AutoBackup: &cloudproject.InstanceAutoBackupArgs{
		Cron:     pulumi.String("string"),
		Rotation: pulumi.Int(0),
	},
	ServiceName: pulumi.String("string"),
	SshKey: &cloudproject.InstanceSshKeyArgs{
		Name: pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	UserData: pulumi.String("string"),
})

    var instanceResource = new Instance("instanceResource", InstanceArgs.builder()
    .region("string")
    .flavor(InstanceFlavorArgs.builder()
        .flavorId("string")
        .build())
    .billingPeriod("string")
    .bootFrom(InstanceBootFromArgs.builder()
        .imageId("string")
        .volumeId("string")
        .build())
    .network(InstanceNetworkArgs.builder()
        .private_(InstanceNetworkPrivateArgs.builder()
            .floatingIp(InstanceNetworkPrivateFloatingIpArgs.builder()
                .id("string")
                .build())
            .floatingIpCreate(InstanceNetworkPrivateFloatingIpCreateArgs.builder()
                .description("string")
                .build())
            .gateway(InstanceNetworkPrivateGatewayArgs.builder()
                .id("string")
                .build())
            .gatewayCreate(InstanceNetworkPrivateGatewayCreateArgs.builder()
                .model("string")
                .name("string")
                .build())
            .ip("string")
            .network(InstanceNetworkPrivateNetworkArgs.builder()
                .id("string")
                .subnetId("string")
                .build())
            .networkCreate(InstanceNetworkPrivateNetworkCreateArgs.builder()
                .name("string")
                .subnet(InstanceNetworkPrivateNetworkCreateSubnetArgs.builder()
                    .cidr("string")
                    .enableDhcp(false)
                    .ipVersion(0)
                    .build())
                .vlanId(0)
                .build())
            .build())
        .public_(false)
        .build())
    .sshKeyCreate(InstanceSshKeyCreateArgs.builder()
        .name("string")
        .publicKey("string")
        .build())
    .bulk(0)
    .group(InstanceGroupArgs.builder()
        .groupId("string")
        .build())
    .availabilityZone("string")
    .autoBackup(InstanceAutoBackupArgs.builder()
        .cron("string")
        .rotation(0)
        .build())
    .serviceName("string")
    .sshKey(InstanceSshKeyArgs.builder()
        .name("string")
        .build())
    .name("string")
    .userData("string")
    .build());

    instance_resource = ovh.cloud_project.Instance("instanceResource",
    region="string",
    flavor={
        "flavor_id": "string",
    },
    billing_period="string",
    boot_from={
        "image_id": "string",
        "volume_id": "string",
    },
    network={
        "private": {
            "floating_ip": {
                "id": "string",
            },
            "floating_ip_create": {
                "description": "string",
            },
            "gateway": {
                "id": "string",
            },
            "gateway_create": {
                "model": "string",
                "name": "string",
            },
            "ip": "string",
            "network": {
                "id": "string",
                "subnet_id": "string",
            },
            "network_create": {
                "name": "string",
                "subnet": {
                    "cidr": "string",
                    "enable_dhcp": False,
                    "ip_version": 0,
                },
                "vlan_id": 0,
            },
        },
        "public": False,
    },
    ssh_key_create={
        "name": "string",
        "public_key": "string",
    },
    bulk=0,
    group={
        "group_id": "string",
    },
    availability_zone="string",
    auto_backup={
        "cron": "string",
        "rotation": 0,
    },
    service_name="string",
    ssh_key={
        "name": "string",
    },
    name="string",
    user_data="string")

    const instanceResource = new ovh.cloudproject.Instance("instanceResource", {
    region: "string",
    flavor: {
        flavorId: "string",
    },
    billingPeriod: "string",
    bootFrom: {
        imageId: "string",
        volumeId: "string",
    },
    network: {
        "private": {
            floatingIp: {
                id: "string",
            },
            floatingIpCreate: {
                description: "string",
            },
            gateway: {
                id: "string",
            },
            gatewayCreate: {
                model: "string",
                name: "string",
            },
            ip: "string",
            network: {
                id: "string",
                subnetId: "string",
            },
            networkCreate: {
                name: "string",
                subnet: {
                    cidr: "string",
                    enableDhcp: false,
                    ipVersion: 0,
                },
                vlanId: 0,
            },
        },
        "public": false,
    },
    sshKeyCreate: {
        name: "string",
        publicKey: "string",
    },
    bulk: 0,
    group: {
        groupId: "string",
    },
    availabilityZone: "string",
    autoBackup: {
        cron: "string",
        rotation: 0,
    },
    serviceName: "string",
    sshKey: {
        name: "string",
    },
    name: "string",
    userData: "string",
});

    type: ovh:CloudProject:Instance
properties:
    autoBackup:
        cron: string
        rotation: 0
    availabilityZone: string
    billingPeriod: string
    bootFrom:
        imageId: string
        volumeId: string
    bulk: 0
    flavor:
        flavorId: string
    group:
        groupId: string
    name: string
    network:
        private:
            floatingIp:
                id: string
            floatingIpCreate:
                description: string
            gateway:
                id: string
            gatewayCreate:
                model: string
                name: string
            ip: string
            network:
                id: string
                subnetId: string
            networkCreate:
                name: string
                subnet:
                    cidr: string
                    enableDhcp: false
                    ipVersion: 0
                vlanId: 0
        public: false
    region: string
    serviceName: string
    sshKey:
        name: string
    sshKeyCreate:
        name: string
        publicKey: string
    userData: 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

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

    The Instance resource accepts the following input properties:

    BillingPeriod string
    Billing period - hourly or monthly
    BootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    Flavor InstanceFlavor
    Flavor information
    Network InstanceNetwork
    Create network interfaces
    Region string
    Instance region
    AutoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    AvailabilityZone string
    The availability zone where the instance will be created
    Bulk int
    Create multiple instances
    Group InstanceGroup
    Start instance in group
    Name string
    Instance name
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    SshKey InstanceSshKey
    Existing SSH Keypair
    SshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    UserData string
    Configuration information or scripts to use upon launch
    BillingPeriod string
    Billing period - hourly or monthly
    BootFrom InstanceBootFromArgs
    Boot the instance from an image or a volume
    Flavor InstanceFlavorArgs
    Flavor information
    Network InstanceNetworkArgs
    Create network interfaces
    Region string
    Instance region
    AutoBackup InstanceAutoBackupArgs
    Create an autobackup workflow after instance start up.
    AvailabilityZone string
    The availability zone where the instance will be created
    Bulk int
    Create multiple instances
    Group InstanceGroupArgs
    Start instance in group
    Name string
    Instance name
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    SshKey InstanceSshKeyArgs
    Existing SSH Keypair
    SshKeyCreate InstanceSshKeyCreateArgs
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    UserData string
    Configuration information or scripts to use upon launch
    billingPeriod String
    Billing period - hourly or monthly
    bootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    flavor InstanceFlavor
    Flavor information
    network InstanceNetwork
    Create network interfaces
    region String
    Instance region
    autoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    availabilityZone String
    The availability zone where the instance will be created
    bulk Integer
    Create multiple instances
    group InstanceGroup
    Start instance in group
    name String
    Instance name
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey InstanceSshKey
    Existing SSH Keypair
    sshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    userData String
    Configuration information or scripts to use upon launch
    billingPeriod string
    Billing period - hourly or monthly
    bootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    flavor InstanceFlavor
    Flavor information
    network InstanceNetwork
    Create network interfaces
    region string
    Instance region
    autoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    availabilityZone string
    The availability zone where the instance will be created
    bulk number
    Create multiple instances
    group InstanceGroup
    Start instance in group
    name string
    Instance name
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey InstanceSshKey
    Existing SSH Keypair
    sshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    userData string
    Configuration information or scripts to use upon launch
    billing_period str
    Billing period - hourly or monthly
    boot_from InstanceBootFromArgs
    Boot the instance from an image or a volume
    flavor InstanceFlavorArgs
    Flavor information
    network InstanceNetworkArgs
    Create network interfaces
    region str
    Instance region
    auto_backup InstanceAutoBackupArgs
    Create an autobackup workflow after instance start up.
    availability_zone str
    The availability zone where the instance will be created
    bulk int
    Create multiple instances
    group InstanceGroupArgs
    Start instance in group
    name str
    Instance name
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    ssh_key InstanceSshKeyArgs
    Existing SSH Keypair
    ssh_key_create InstanceSshKeyCreateArgs
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    user_data str
    Configuration information or scripts to use upon launch
    billingPeriod String
    Billing period - hourly or monthly
    bootFrom Property Map
    Boot the instance from an image or a volume
    flavor Property Map
    Flavor information
    network Property Map
    Create network interfaces
    region String
    Instance region
    autoBackup Property Map
    Create an autobackup workflow after instance start up.
    availabilityZone String
    The availability zone where the instance will be created
    bulk Number
    Create multiple instances
    group Property Map
    Start instance in group
    name String
    Instance name
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey Property Map
    Existing SSH Keypair
    sshKeyCreate Property Map
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    userData String
    Configuration information or scripts to use upon launch

    Outputs

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

    Addresses List<InstanceAddress>
    Instance IP addresses
    AttachedVolumes List<InstanceAttachedVolume>
    Volumes attached to the instance
    FlavorId string
    Flavor id
    FlavorName string
    Flavor name
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    Image id
    Status string
    Instance status
    TaskState string
    Instance task state
    Addresses []InstanceAddress
    Instance IP addresses
    AttachedVolumes []InstanceAttachedVolume
    Volumes attached to the instance
    FlavorId string
    Flavor id
    FlavorName string
    Flavor name
    Id string
    The provider-assigned unique ID for this managed resource.
    ImageId string
    Image id
    Status string
    Instance status
    TaskState string
    Instance task state
    addresses List<InstanceAddress>
    Instance IP addresses
    attachedVolumes List<InstanceAttachedVolume>
    Volumes attached to the instance
    flavorId String
    Flavor id
    flavorName String
    Flavor name
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    Image id
    status String
    Instance status
    taskState String
    Instance task state
    addresses InstanceAddress[]
    Instance IP addresses
    attachedVolumes InstanceAttachedVolume[]
    Volumes attached to the instance
    flavorId string
    Flavor id
    flavorName string
    Flavor name
    id string
    The provider-assigned unique ID for this managed resource.
    imageId string
    Image id
    status string
    Instance status
    taskState string
    Instance task state
    addresses Sequence[InstanceAddress]
    Instance IP addresses
    attached_volumes Sequence[InstanceAttachedVolume]
    Volumes attached to the instance
    flavor_id str
    Flavor id
    flavor_name str
    Flavor name
    id str
    The provider-assigned unique ID for this managed resource.
    image_id str
    Image id
    status str
    Instance status
    task_state str
    Instance task state
    addresses List<Property Map>
    Instance IP addresses
    attachedVolumes List<Property Map>
    Volumes attached to the instance
    flavorId String
    Flavor id
    flavorName String
    Flavor name
    id String
    The provider-assigned unique ID for this managed resource.
    imageId String
    Image id
    status String
    Instance status
    taskState String
    Instance task state

    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,
        addresses: Optional[Sequence[InstanceAddressArgs]] = None,
        attached_volumes: Optional[Sequence[InstanceAttachedVolumeArgs]] = None,
        auto_backup: Optional[InstanceAutoBackupArgs] = None,
        availability_zone: Optional[str] = None,
        billing_period: Optional[str] = None,
        boot_from: Optional[InstanceBootFromArgs] = None,
        bulk: Optional[int] = None,
        flavor: Optional[InstanceFlavorArgs] = None,
        flavor_id: Optional[str] = None,
        flavor_name: Optional[str] = None,
        group: Optional[InstanceGroupArgs] = None,
        image_id: Optional[str] = None,
        name: Optional[str] = None,
        network: Optional[InstanceNetworkArgs] = None,
        region: Optional[str] = None,
        service_name: Optional[str] = None,
        ssh_key: Optional[InstanceSshKeyArgs] = None,
        ssh_key_create: Optional[InstanceSshKeyCreateArgs] = None,
        status: Optional[str] = None,
        task_state: Optional[str] = None,
        user_data: Optional[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)
    resources:  _:    type: ovh:CloudProject:Instance    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:
    Addresses List<InstanceAddress>
    Instance IP addresses
    AttachedVolumes List<InstanceAttachedVolume>
    Volumes attached to the instance
    AutoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    AvailabilityZone string
    The availability zone where the instance will be created
    BillingPeriod string
    Billing period - hourly or monthly
    BootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    Bulk int
    Create multiple instances
    Flavor InstanceFlavor
    Flavor information
    FlavorId string
    Flavor id
    FlavorName string
    Flavor name
    Group InstanceGroup
    Start instance in group
    ImageId string
    Image id
    Name string
    Instance name
    Network InstanceNetwork
    Create network interfaces
    Region string
    Instance region
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    SshKey InstanceSshKey
    Existing SSH Keypair
    SshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    Status string
    Instance status
    TaskState string
    Instance task state
    UserData string
    Configuration information or scripts to use upon launch
    Addresses []InstanceAddressArgs
    Instance IP addresses
    AttachedVolumes []InstanceAttachedVolumeArgs
    Volumes attached to the instance
    AutoBackup InstanceAutoBackupArgs
    Create an autobackup workflow after instance start up.
    AvailabilityZone string
    The availability zone where the instance will be created
    BillingPeriod string
    Billing period - hourly or monthly
    BootFrom InstanceBootFromArgs
    Boot the instance from an image or a volume
    Bulk int
    Create multiple instances
    Flavor InstanceFlavorArgs
    Flavor information
    FlavorId string
    Flavor id
    FlavorName string
    Flavor name
    Group InstanceGroupArgs
    Start instance in group
    ImageId string
    Image id
    Name string
    Instance name
    Network InstanceNetworkArgs
    Create network interfaces
    Region string
    Instance region
    ServiceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    SshKey InstanceSshKeyArgs
    Existing SSH Keypair
    SshKeyCreate InstanceSshKeyCreateArgs
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    Status string
    Instance status
    TaskState string
    Instance task state
    UserData string
    Configuration information or scripts to use upon launch
    addresses List<InstanceAddress>
    Instance IP addresses
    attachedVolumes List<InstanceAttachedVolume>
    Volumes attached to the instance
    autoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    availabilityZone String
    The availability zone where the instance will be created
    billingPeriod String
    Billing period - hourly or monthly
    bootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    bulk Integer
    Create multiple instances
    flavor InstanceFlavor
    Flavor information
    flavorId String
    Flavor id
    flavorName String
    Flavor name
    group InstanceGroup
    Start instance in group
    imageId String
    Image id
    name String
    Instance name
    network InstanceNetwork
    Create network interfaces
    region String
    Instance region
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey InstanceSshKey
    Existing SSH Keypair
    sshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    status String
    Instance status
    taskState String
    Instance task state
    userData String
    Configuration information or scripts to use upon launch
    addresses InstanceAddress[]
    Instance IP addresses
    attachedVolumes InstanceAttachedVolume[]
    Volumes attached to the instance
    autoBackup InstanceAutoBackup
    Create an autobackup workflow after instance start up.
    availabilityZone string
    The availability zone where the instance will be created
    billingPeriod string
    Billing period - hourly or monthly
    bootFrom InstanceBootFrom
    Boot the instance from an image or a volume
    bulk number
    Create multiple instances
    flavor InstanceFlavor
    Flavor information
    flavorId string
    Flavor id
    flavorName string
    Flavor name
    group InstanceGroup
    Start instance in group
    imageId string
    Image id
    name string
    Instance name
    network InstanceNetwork
    Create network interfaces
    region string
    Instance region
    serviceName string
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey InstanceSshKey
    Existing SSH Keypair
    sshKeyCreate InstanceSshKeyCreate
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    status string
    Instance status
    taskState string
    Instance task state
    userData string
    Configuration information or scripts to use upon launch
    addresses Sequence[InstanceAddressArgs]
    Instance IP addresses
    attached_volumes Sequence[InstanceAttachedVolumeArgs]
    Volumes attached to the instance
    auto_backup InstanceAutoBackupArgs
    Create an autobackup workflow after instance start up.
    availability_zone str
    The availability zone where the instance will be created
    billing_period str
    Billing period - hourly or monthly
    boot_from InstanceBootFromArgs
    Boot the instance from an image or a volume
    bulk int
    Create multiple instances
    flavor InstanceFlavorArgs
    Flavor information
    flavor_id str
    Flavor id
    flavor_name str
    Flavor name
    group InstanceGroupArgs
    Start instance in group
    image_id str
    Image id
    name str
    Instance name
    network InstanceNetworkArgs
    Create network interfaces
    region str
    Instance region
    service_name str
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    ssh_key InstanceSshKeyArgs
    Existing SSH Keypair
    ssh_key_create InstanceSshKeyCreateArgs
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    status str
    Instance status
    task_state str
    Instance task state
    user_data str
    Configuration information or scripts to use upon launch
    addresses List<Property Map>
    Instance IP addresses
    attachedVolumes List<Property Map>
    Volumes attached to the instance
    autoBackup Property Map
    Create an autobackup workflow after instance start up.
    availabilityZone String
    The availability zone where the instance will be created
    billingPeriod String
    Billing period - hourly or monthly
    bootFrom Property Map
    Boot the instance from an image or a volume
    bulk Number
    Create multiple instances
    flavor Property Map
    Flavor information
    flavorId String
    Flavor id
    flavorName String
    Flavor name
    group Property Map
    Start instance in group
    imageId String
    Image id
    name String
    Instance name
    network Property Map
    Create network interfaces
    region String
    Instance region
    serviceName String
    The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used
    sshKey Property Map
    Existing SSH Keypair
    sshKeyCreate Property Map
    Add existing SSH Key pair into your Public Cloud project and link it to the instance
    status String
    Instance status
    taskState String
    Instance task state
    userData String
    Configuration information or scripts to use upon launch

    Supporting Types

    InstanceAddress, InstanceAddressArgs

    Ip string
    IP address
    Version int
    IP version
    Ip string
    IP address
    Version int
    IP version
    ip String
    IP address
    version Integer
    IP version
    ip string
    IP address
    version number
    IP version
    ip str
    IP address
    version int
    IP version
    ip String
    IP address
    version Number
    IP version

    InstanceAttachedVolume, InstanceAttachedVolumeArgs

    Id string
    Instance id
    Id string
    Instance id
    id String
    Instance id
    id string
    Instance id
    id str
    Instance id
    id String
    Instance id

    InstanceAutoBackup, InstanceAutoBackupArgs

    Cron string
    Unix cron pattern
    Rotation int
    Number of backup to keep
    Cron string
    Unix cron pattern
    Rotation int
    Number of backup to keep
    cron String
    Unix cron pattern
    rotation Integer
    Number of backup to keep
    cron string
    Unix cron pattern
    rotation number
    Number of backup to keep
    cron str
    Unix cron pattern
    rotation int
    Number of backup to keep
    cron String
    Unix cron pattern
    rotation Number
    Number of backup to keep

    InstanceBootFrom, InstanceBootFromArgs

    ImageId string
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    VolumeId string
    Instance volume id
    ImageId string
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    VolumeId string
    Instance volume id
    imageId String
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    volumeId String
    Instance volume id
    imageId string
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    volumeId string
    Instance volume id
    image_id str
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    volume_id str
    Instance volume id
    imageId String
    Instance image id. Images can be retrieved using GET /cloud/project/{serviceName}/image
    volumeId String
    Instance volume id

    InstanceFlavor, InstanceFlavorArgs

    FlavorId string
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor
    FlavorId string
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor
    flavorId String
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor
    flavorId string
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor
    flavor_id str
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor
    flavorId String
    Flavor ID. Flavors can be retrieved using GET /cloud/project/{serviceName}/flavor

    InstanceGroup, InstanceGroupArgs

    GroupId string
    Group id
    GroupId string
    Group id
    groupId String
    Group id
    groupId string
    Group id
    group_id str
    Group id
    groupId String
    Group id

    InstanceNetwork, InstanceNetworkArgs

    Private InstanceNetworkPrivate
    Private network information
    Public bool
    Set the new instance as public
    Private InstanceNetworkPrivate
    Private network information
    Public bool
    Set the new instance as public
    private_ InstanceNetworkPrivate
    Private network information
    public_ Boolean
    Set the new instance as public
    private InstanceNetworkPrivate
    Private network information
    public boolean
    Set the new instance as public
    private InstanceNetworkPrivate
    Private network information
    public bool
    Set the new instance as public
    private Property Map
    Private network information
    public Boolean
    Set the new instance as public

    InstanceNetworkPrivate, InstanceNetworkPrivateArgs

    FloatingIp InstanceNetworkPrivateFloatingIp
    Existing floating IP
    FloatingIpCreate InstanceNetworkPrivateFloatingIpCreate
    Information to create a new floating IP
    Gateway InstanceNetworkPrivateGateway
    Existing gateway
    GatewayCreate InstanceNetworkPrivateGatewayCreate
    Information to create a new gateway
    Ip string
    Instance IP in the private network
    Network InstanceNetworkPrivateNetwork
    Existing private network
    NetworkCreate InstanceNetworkPrivateNetworkCreate
    Information to create a new private network
    FloatingIp InstanceNetworkPrivateFloatingIp
    Existing floating IP
    FloatingIpCreate InstanceNetworkPrivateFloatingIpCreate
    Information to create a new floating IP
    Gateway InstanceNetworkPrivateGateway
    Existing gateway
    GatewayCreate InstanceNetworkPrivateGatewayCreate
    Information to create a new gateway
    Ip string
    Instance IP in the private network
    Network InstanceNetworkPrivateNetwork
    Existing private network
    NetworkCreate InstanceNetworkPrivateNetworkCreate
    Information to create a new private network
    floatingIp InstanceNetworkPrivateFloatingIp
    Existing floating IP
    floatingIpCreate InstanceNetworkPrivateFloatingIpCreate
    Information to create a new floating IP
    gateway InstanceNetworkPrivateGateway
    Existing gateway
    gatewayCreate InstanceNetworkPrivateGatewayCreate
    Information to create a new gateway
    ip String
    Instance IP in the private network
    network InstanceNetworkPrivateNetwork
    Existing private network
    networkCreate InstanceNetworkPrivateNetworkCreate
    Information to create a new private network
    floatingIp InstanceNetworkPrivateFloatingIp
    Existing floating IP
    floatingIpCreate InstanceNetworkPrivateFloatingIpCreate
    Information to create a new floating IP
    gateway InstanceNetworkPrivateGateway
    Existing gateway
    gatewayCreate InstanceNetworkPrivateGatewayCreate
    Information to create a new gateway
    ip string
    Instance IP in the private network
    network InstanceNetworkPrivateNetwork
    Existing private network
    networkCreate InstanceNetworkPrivateNetworkCreate
    Information to create a new private network
    floating_ip InstanceNetworkPrivateFloatingIp
    Existing floating IP
    floating_ip_create InstanceNetworkPrivateFloatingIpCreate
    Information to create a new floating IP
    gateway InstanceNetworkPrivateGateway
    Existing gateway
    gateway_create InstanceNetworkPrivateGatewayCreate
    Information to create a new gateway
    ip str
    Instance IP in the private network
    network InstanceNetworkPrivateNetwork
    Existing private network
    network_create InstanceNetworkPrivateNetworkCreate
    Information to create a new private network
    floatingIp Property Map
    Existing floating IP
    floatingIpCreate Property Map
    Information to create a new floating IP
    gateway Property Map
    Existing gateway
    gatewayCreate Property Map
    Information to create a new gateway
    ip String
    Instance IP in the private network
    network Property Map
    Existing private network
    networkCreate Property Map
    Information to create a new private network

    InstanceNetworkPrivateFloatingIp, InstanceNetworkPrivateFloatingIpArgs

    Id string
    Floating IP ID
    Id string
    Floating IP ID
    id String
    Floating IP ID
    id string
    Floating IP ID
    id str
    Floating IP ID
    id String
    Floating IP ID

    InstanceNetworkPrivateFloatingIpCreate, InstanceNetworkPrivateFloatingIpCreateArgs

    Description string
    Floating IP description
    Description string
    Floating IP description
    description String
    Floating IP description
    description string
    Floating IP description
    description str
    Floating IP description
    description String
    Floating IP description

    InstanceNetworkPrivateGateway, InstanceNetworkPrivateGatewayArgs

    Id string
    Gateway ID
    Id string
    Gateway ID
    id String
    Gateway ID
    id string
    Gateway ID
    id str
    Gateway ID
    id String
    Gateway ID

    InstanceNetworkPrivateGatewayCreate, InstanceNetworkPrivateGatewayCreateArgs

    Model string
    Gateway model (s | m | l)
    Name string
    Gateway name
    Model string
    Gateway model (s | m | l)
    Name string
    Gateway name
    model String
    Gateway model (s | m | l)
    name String
    Gateway name
    model string
    Gateway model (s | m | l)
    name string
    Gateway name
    model str
    Gateway model (s | m | l)
    name str
    Gateway name
    model String
    Gateway model (s | m | l)
    name String
    Gateway name

    InstanceNetworkPrivateNetwork, InstanceNetworkPrivateNetworkArgs

    Id string
    Network ID
    SubnetId string
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network
    Id string
    Network ID
    SubnetId string
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network
    id String
    Network ID
    subnetId String
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network
    id string
    Network ID
    subnetId string
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network
    id str
    Network ID
    subnet_id str
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network
    id String
    Network ID
    subnetId String
    Existing subnet ID

    • network_create - (Optional, Forces new resource) Information to create a new private network

    InstanceNetworkPrivateNetworkCreate, InstanceNetworkPrivateNetworkCreateArgs

    Name string
    Instance name
    Subnet InstanceNetworkPrivateNetworkCreateSubnet
    New subnet information
    VlanId int
    Network vlan ID
    Name string
    Instance name
    Subnet InstanceNetworkPrivateNetworkCreateSubnet
    New subnet information
    VlanId int
    Network vlan ID
    name String
    Instance name
    subnet InstanceNetworkPrivateNetworkCreateSubnet
    New subnet information
    vlanId Integer
    Network vlan ID
    name string
    Instance name
    subnet InstanceNetworkPrivateNetworkCreateSubnet
    New subnet information
    vlanId number
    Network vlan ID
    name str
    Instance name
    subnet InstanceNetworkPrivateNetworkCreateSubnet
    New subnet information
    vlan_id int
    Network vlan ID
    name String
    Instance name
    subnet Property Map
    New subnet information
    vlanId Number
    Network vlan ID

    InstanceNetworkPrivateNetworkCreateSubnet, InstanceNetworkPrivateNetworkCreateSubnetArgs

    Cidr string
    Subnet range in CIDR notation
    EnableDhcp bool
    Whether to enable DHCP
    IpVersion int
    IP version
    Cidr string
    Subnet range in CIDR notation
    EnableDhcp bool
    Whether to enable DHCP
    IpVersion int
    IP version
    cidr String
    Subnet range in CIDR notation
    enableDhcp Boolean
    Whether to enable DHCP
    ipVersion Integer
    IP version
    cidr string
    Subnet range in CIDR notation
    enableDhcp boolean
    Whether to enable DHCP
    ipVersion number
    IP version
    cidr str
    Subnet range in CIDR notation
    enable_dhcp bool
    Whether to enable DHCP
    ip_version int
    IP version
    cidr String
    Subnet range in CIDR notation
    enableDhcp Boolean
    Whether to enable DHCP
    ipVersion Number
    IP version

    InstanceSshKey, InstanceSshKeyArgs

    Name string
    SSH Keypair name
    Name string
    SSH Keypair name
    name String
    SSH Keypair name
    name string
    SSH Keypair name
    name str
    SSH Keypair name
    name String
    SSH Keypair name

    InstanceSshKeyCreate, InstanceSshKeyCreateArgs

    Name string
    SSH Key pair name
    PublicKey string
    SSH Public key
    Name string
    SSH Key pair name
    PublicKey string
    SSH Public key
    name String
    SSH Key pair name
    publicKey String
    SSH Public key
    name string
    SSH Key pair name
    publicKey string
    SSH Public key
    name str
    SSH Key pair name
    public_key str
    SSH Public key
    name String
    SSH Key pair name
    publicKey String
    SSH Public key

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    OVHCloud v2.2.3 published on Friday, Jun 6, 2025 by OVHcloud
    ovh/pulumi-ovh