Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. OVH
  4. API Docs
  5. CloudInstance
Viewing docs for OVHCloud v2.19.1
published on Tuesday, Aug 18, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

ovh.CloudInstance

ovh logo
Viewing docs for OVHCloud v2.19.1
published on Tuesday, Aug 18, 2026 by OVHcloud
Schema (JSON)
ovh/pulumi-ovh

    Creates an instance in a public cloud project.

    WARNING Changing image_id rebuilds the instance and wipes the root disk. Back up any data on the root disk before changing the image.

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  instance:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-instance
      flavorId: <flavor id>
      imageId: <image id>
      sshKeyName: my-ssh-key
      networks:
        - auto_assign_public_ip: true

    Example coming soon!

    Network interfaces

    A networks[] entry supports four shapes. Entries keep the order they are written in: the API returns them sorted by network id and the provider re-orders them back to the configuration.

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  networks:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-multi-homed-instance
      flavorId: <flavor id>
      imageId: <image id>
      networks:
        - auto_assign_public_ip: true
        - ip: 203.0.113.10
        - network_id: <private network id>
          subnet_id: <subnet id>
        - network_id: <private network id>
          subnet_id: <subnet id>
          ip: 10.0.0.42

    Example coming soon!

    Private-network-only instance

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  private:
    type: ovh:CloudNetworkPrivateVrack
    properties:
      serviceName: <Public cloud project id>
      name: my-private-network
      region: GRA11
  privateCloudNetworkPrivateVrackSubnet:
    type: ovh:CloudNetworkPrivateVrackSubnet
    name: private
    properties:
      serviceName: ${private.serviceName}
      networkId: ${private.id}
      name: my-subnet
      cidr: 10.0.0.0/24
      region: GRA11
  # No public interface at all: the instance is only reachable from the vRack.
  # Add an ovh_cloud_gateway on the same subnet to give it egress.
  privateOnly:
    type: ovh:CloudInstance
    name: private_only
    properties:
      serviceName: ${private.serviceName}
      region: GRA11
      name: my-private-instance
      flavorId: <flavor id>
      imageId: <image id>
      networks:
        - network_id: ${private.id}
          subnet_id: ${privateCloudNetworkPrivateVrackSubnet.id}

    Example coming soon!

    Boot from volume

    Omit image_id and pass a bootable volume in volume_ids. The instance’s current_state.image stays null for a boot-from-volume instance.

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  boot:
    type: ovh:CloudStorageBlockVolume
    properties:
      serviceName: <Public cloud project id>
      name: my-boot-volume
      size: 50
      region: GRA11
      volumeType: HIGH_SPEED_GEN2
      createFrom:
        image_id: <image id>
  bootFromVolume:
    type: ovh:CloudInstance
    name: boot_from_volume
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-boot-from-volume-instance
      flavorId: <flavor id>
      volumeIds:
        - ${boot.id}
      networks:
        - auto_assign_public_ip: true

    Example coming soon!

    Attaching additional block volumes

    volume_ids is mutable: adding or removing an id attaches or detaches the volume in place, without recreating the instance.

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  data:
    type: ovh:CloudStorageBlockVolume
    properties:
      serviceName: <Public cloud project id>
      name: my-data-volume
      size: 100
      region: GRA11
      volumeType: CLASSIC
  withVolumes:
    type: ovh:CloudInstance
    name: with_volumes
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-instance-with-volumes
      flavorId: <flavor id>
      imageId: <image id>
      volumeIds:
        - ${data.id}
      networks:
        - auto_assign_public_ip: true

    Example coming soon!

    Security groups

    security_group_ids is optional and computed:

    • omitted — the platform applies the project’s default security group and writes it into the target spec, so after the first apply security_group_ids holds exactly that one group id. Removing the attribute from a configuration that used to set it therefore keeps the groups already attached; it does not detach them.
    • explicit empty list (security_group_ids = []) — no security group is applied at all. The instance accepts no inbound traffic; use it only when the filtering is handled elsewhere.
    • explicit list of ids — exactly those groups are applied to every interface.
    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  web:
    type: ovh:CloudSecurityGroup
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-web-security-group
      description: Allow SSH and HTTPS
      rules:
        - direction: INGRESS
          ethernet_type: IPV4
          protocol: TCP
          port_range_min: 22
          port_range_max: 22
          remote_ip_prefix: 0.0.0.0/0
          description: SSH
  filtered:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-filtered-instance
      flavorId: <flavor id>
      imageId: <image id>
      securityGroupIds:
        - ${web.id}
      networks:
        - auto_assign_public_ip: true
  # No security group at all: the instance accepts no inbound traffic.
  noFiltering:
    type: ovh:CloudInstance
    name: no_filtering
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-unfiltered-instance
      flavorId: <flavor id>
      imageId: <image id>
      securityGroupIds: []
      networks:
        - auto_assign_public_ip: true

    Example coming soon!

    Attaching file storage shares

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  share:
    type: ovh:CloudStorageFileShare
    properties:
      serviceName: <Public cloud project id>
      name: my-share
      size: 150
      region: GRA11
      protocol: NFS
      shareType: STANDARD_1AZ
      shareNetworkId: <share network id>
  # No ovh_cloud_storage_file_share_acl resource targets this share: the instance
  # below owns its access rules.
  withShares:
    type: ovh:CloudInstance
    name: with_shares
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-instance-with-shares
      flavorId: <flavor id>
      imageId: <image id>
      shares:
        - id: ${share.id}
        - id: <read only share id>
          access_level: READ_ONLY
      networks:
        - network_id: <private network id>
          subnet_id: <subnet id>

    Example coming soon!

    Power state

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  # The instance stays provisioned and keeps its disks, ports and IPs, but the
  # VM is powered off.
  stopped:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-stopped-instance
      flavorId: <flavor id>
      imageId: <image id>
      powerState: SHUTOFF
      networks:
        - auto_assign_public_ip: true
  # Powered off and released on the hypervisor. Switching power_state back to
  # ACTIVE unshelves it in place.
  shelved:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-shelved-instance
      flavorId: <flavor id>
      imageId: <image id>
      powerState: SHELVED
      networks:
        - auto_assign_public_ip: true

    Example coming soon!

    Joining an instance group

    Group membership is only settable here, through the instance’s group_id. See ovh.CloudInstanceGroup.

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  spread:
    type: ovh:CloudInstanceGroup
    properties:
      serviceName: <Public cloud project id>
      region: GRA11
      name: my-anti-affinity-group
      policy: ANTI_AFFINITY
  grouped:
    type: ovh:CloudInstance
    properties:
      serviceName: <Public cloud project id>
      region: ${spread.region}
      name: my-grouped-instance-${range.value}
      flavorId: <flavor id>
      imageId: <image id>
      groupId: ${spread.id}
      networks:
        - auto_assign_public_ip: true
    options: {}

    Example coming soon!

    Operational notes

    • Create, update and delete poll the API until the instance settles, for up to 60 minutes each. The resource offers no timeouts {} block, so that budget cannot be shortened or extended from the configuration.
    • An update re-reads the instance immediately before issuing the PUT, so the checksum it sends is the freshest one. This keeps a concurrent server-side change from failing the apply with a ChecksumMismatch (HTTP 409).
    • resource_status = "ERROR" is terminal: polling stops at once and the provider surfaces the summary of the failed task(s) instead of a generic unexpected-state error.

    Create CloudInstance Resource

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

    Constructor syntax

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

@overload
def CloudInstance(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  region: Optional[str] = None,
                  flavor_id: Optional[str] = None,
                  service_name: Optional[str] = None,
                  image_id: Optional[str] = None,
                  name: Optional[str] = None,
                  networks: Optional[Sequence[CloudInstanceNetworkArgs]] = None,
                  power_state: Optional[str] = None,
                  availability_zone: Optional[str] = None,
                  security_group_ids: Optional[Sequence[str]] = None,
                  group_id: Optional[str] = None,
                  shares: Optional[Sequence[CloudInstanceShareArgs]] = None,
                  ssh_key_name: Optional[str] = None,
                  volume_ids: Optional[Sequence[str]] = None)
    func NewCloudInstance(ctx *Context, name string, args CloudInstanceArgs, opts ...ResourceOption) (*CloudInstance, error)
    public CloudInstance(string name, CloudInstanceArgs args, CustomResourceOptions? opts = null)
    public CloudInstance(String name, CloudInstanceArgs args)
public CloudInstance(String name, CloudInstanceArgs args, CustomResourceOptions options)

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


    resource "ovh_cloud_instance" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args CloudInstanceArgs
    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 CloudInstanceArgs
    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 CloudInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CloudInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CloudInstanceArgs
    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 cloudInstanceResource = new Ovh.CloudInstance("cloudInstanceResource", new()
{
    Region = "string",
    FlavorId = "string",
    ServiceName = "string",
    ImageId = "string",
    Name = "string",
    Networks = new[]
    {
        new Ovh.Inputs.CloudInstanceNetworkArgs
        {
            AutoAssignPublicIp = false,
            Ip = "string",
            NetworkId = "string",
            SubnetId = "string",
        },
    },
    PowerState = "string",
    AvailabilityZone = "string",
    SecurityGroupIds = new[]
    {
        "string",
    },
    GroupId = "string",
    Shares = new[]
    {
        new Ovh.Inputs.CloudInstanceShareArgs
        {
            Id = "string",
            AccessLevel = "string",
        },
    },
    SshKeyName = "string",
    VolumeIds = new[]
    {
        "string",
    },
});

    example, err := ovh.NewCloudInstance(ctx, "cloudInstanceResource", &ovh.CloudInstanceArgs{
	Region:      pulumi.String("string"),
	FlavorId:    pulumi.String("string"),
	ServiceName: pulumi.String("string"),
	ImageId:     pulumi.String("string"),
	Name:        pulumi.String("string"),
	Networks: ovh.CloudInstanceNetworkArray{
		&ovh.CloudInstanceNetworkArgs{
			AutoAssignPublicIp: pulumi.Bool(false),
			Ip:                 pulumi.String("string"),
			NetworkId:          pulumi.String("string"),
			SubnetId:           pulumi.String("string"),
		},
	},
	PowerState:       pulumi.String("string"),
	AvailabilityZone: pulumi.String("string"),
	SecurityGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupId: pulumi.String("string"),
	Shares: ovh.CloudInstanceShareArray{
		&ovh.CloudInstanceShareArgs{
			Id:          pulumi.String("string"),
			AccessLevel: pulumi.String("string"),
		},
	},
	SshKeyName: pulumi.String("string"),
	VolumeIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    resource "ovh_cloud_instance" "cloudInstanceResource" {
  lifecycle {
    create_before_destroy = true
  }
  region       = "string"
  flavor_id    = "string"
  service_name = "string"
  image_id     = "string"
  name         = "string"
  networks {
    auto_assign_public_ip = false
    ip                    = "string"
    network_id            = "string"
    subnet_id             = "string"
  }
  power_state        = "string"
  availability_zone  = "string"
  security_group_ids = ["string"]
  group_id           = "string"
  shares {
    id           = "string"
    access_level = "string"
  }
  ssh_key_name = "string"
  volume_ids   = ["string"]
}

    var cloudInstanceResource = new CloudInstance("cloudInstanceResource", CloudInstanceArgs.builder()
    .region("string")
    .flavorId("string")
    .serviceName("string")
    .imageId("string")
    .name("string")
    .networks(CloudInstanceNetworkArgs.builder()
        .autoAssignPublicIp(false)
        .ip("string")
        .networkId("string")
        .subnetId("string")
        .build())
    .powerState("string")
    .availabilityZone("string")
    .securityGroupIds("string")
    .groupId("string")
    .shares(CloudInstanceShareArgs.builder()
        .id("string")
        .accessLevel("string")
        .build())
    .sshKeyName("string")
    .volumeIds("string")
    .build());

    cloud_instance_resource = ovh.CloudInstance("cloudInstanceResource",
    region="string",
    flavor_id="string",
    service_name="string",
    image_id="string",
    name="string",
    networks=[{
        "auto_assign_public_ip": False,
        "ip": "string",
        "network_id": "string",
        "subnet_id": "string",
    }],
    power_state="string",
    availability_zone="string",
    security_group_ids=["string"],
    group_id="string",
    shares=[{
        "id": "string",
        "access_level": "string",
    }],
    ssh_key_name="string",
    volume_ids=["string"])

    const cloudInstanceResource = new ovh.CloudInstance("cloudInstanceResource", {
    region: "string",
    flavorId: "string",
    serviceName: "string",
    imageId: "string",
    name: "string",
    networks: [{
        autoAssignPublicIp: false,
        ip: "string",
        networkId: "string",
        subnetId: "string",
    }],
    powerState: "string",
    availabilityZone: "string",
    securityGroupIds: ["string"],
    groupId: "string",
    shares: [{
        id: "string",
        accessLevel: "string",
    }],
    sshKeyName: "string",
    volumeIds: ["string"],
});

    type: ovh:CloudInstance
properties:
    availabilityZone: string
    flavorId: string
    groupId: string
    imageId: string
    name: string
    networks:
        - autoAssignPublicIp: false
          ip: string
          networkId: string
          subnetId: string
    powerState: string
    region: string
    securityGroupIds:
        - string
    serviceName: string
    shares:
        - accessLevel: string
          id: string
    sshKeyName: string
    volumeIds:
        - string

    CloudInstance 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 CloudInstance resource accepts the following input properties:

    FlavorId string
    Flavor ID. Changing it resizes the instance in place.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    GroupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    ImageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    Name string
    Instance name.
    Networks List<CloudInstanceNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    SecurityGroupIds List<string>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    Shares List<CloudInstanceShare>
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    VolumeIds List<string>
    IDs of block-storage volumes attached to the instance.
    FlavorId string
    Flavor ID. Changing it resizes the instance in place.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    GroupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    ImageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    Name string
    Instance name.
    Networks []CloudInstanceNetworkArgs
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    SecurityGroupIds []string
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    Shares []CloudInstanceShareArgs
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    VolumeIds []string
    IDs of block-storage volumes attached to the instance.
    flavor_id string
    Flavor ID. Changing it resizes the instance in place.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    service_name string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availability_zone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    group_id string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    image_id string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name string
    Instance name.
    networks list(object)
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    security_group_ids list(string)
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    shares list(object)
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    volume_ids list(string)
    IDs of block-storage volumes attached to the instance.
    flavorId String
    Flavor ID. Changing it resizes the instance in place.
    region String
    Region where the instance is created. Changing this value recreates the resource.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    groupId String
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId String
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name String
    Instance name.
    networks List<CloudInstanceNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    securityGroupIds List<String>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    shares List<CloudInstanceShare>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    volumeIds List<String>
    IDs of block-storage volumes attached to the instance.
    flavorId string
    Flavor ID. Changing it resizes the instance in place.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    groupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name string
    Instance name.
    networks CloudInstanceNetwork[]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    securityGroupIds string[]
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    shares CloudInstanceShare[]
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    volumeIds string[]
    IDs of block-storage volumes attached to the instance.
    flavor_id str
    Flavor ID. Changing it resizes the instance in place.
    region str
    Region where the instance is created. Changing this value recreates the resource.
    service_name str
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availability_zone str
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    group_id str
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    image_id str
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name str
    Instance name.
    networks Sequence[CloudInstanceNetworkArgs]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state str
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    security_group_ids Sequence[str]
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    shares Sequence[CloudInstanceShareArgs]
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name str
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    volume_ids Sequence[str]
    IDs of block-storage volumes attached to the instance.
    flavorId String
    Flavor ID. Changing it resizes the instance in place.
    region String
    Region where the instance is created. Changing this value recreates the resource.
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    groupId String
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId String
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name String
    Instance name.
    networks List<Property Map>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    securityGroupIds List<String>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    shares List<Property Map>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    volumeIds List<String>
    IDs of block-storage volumes attached to the instance.

    Outputs

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

    Checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    CreatedAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    CurrentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    UpdatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    Checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    CreatedAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    CurrentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    Id string
    The provider-assigned unique ID for this managed resource.
    ResourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    UpdatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    created_at string
    Creation date of the instance, as an RFC 3339 timestamp.
    current_state object
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    id string
    The provider-assigned unique ID for this managed resource.
    resource_status string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    updated_at string
    Last modification date of the instance, as an RFC 3339 timestamp.
    checksum String
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt String
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    updatedAt String
    Last modification date of the instance, as an RFC 3339 timestamp.
    checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    id string
    The provider-assigned unique ID for this managed resource.
    resourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    updatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    checksum str
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    created_at str
    Creation date of the instance, as an RFC 3339 timestamp.
    current_state CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    id str
    The provider-assigned unique ID for this managed resource.
    resource_status str
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    updated_at str
    Last modification date of the instance, as an RFC 3339 timestamp.
    checksum String
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt String
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState Property Map
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    id String
    The provider-assigned unique ID for this managed resource.
    resourceStatus String
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    updatedAt String
    Last modification date of the instance, as an RFC 3339 timestamp.

    Look up Existing CloudInstance Resource

    Get an existing CloudInstance 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?: CloudInstanceState, opts?: CustomResourceOptions): CloudInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        availability_zone: Optional[str] = None,
        checksum: Optional[str] = None,
        created_at: Optional[str] = None,
        current_state: Optional[CloudInstanceCurrentStateArgs] = None,
        flavor_id: Optional[str] = None,
        group_id: Optional[str] = None,
        image_id: Optional[str] = None,
        name: Optional[str] = None,
        networks: Optional[Sequence[CloudInstanceNetworkArgs]] = None,
        power_state: Optional[str] = None,
        region: Optional[str] = None,
        resource_status: Optional[str] = None,
        security_group_ids: Optional[Sequence[str]] = None,
        service_name: Optional[str] = None,
        shares: Optional[Sequence[CloudInstanceShareArgs]] = None,
        ssh_key_name: Optional[str] = None,
        updated_at: Optional[str] = None,
        volume_ids: Optional[Sequence[str]] = None) -> CloudInstance
    func GetCloudInstance(ctx *Context, name string, id IDInput, state *CloudInstanceState, opts ...ResourceOption) (*CloudInstance, error)
    public static CloudInstance Get(string name, Input<string> id, CloudInstanceState? state, CustomResourceOptions? opts = null)
    public static CloudInstance get(String name, Output<String> id, CloudInstanceState state, CustomResourceOptions options)
    resources:  _:    type: ovh:CloudInstance    get:      id: ${id}
    import {
  to = ovh_cloud_instance.example
  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:
    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    Checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    CreatedAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    CurrentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    FlavorId string
    Flavor ID. Changing it resizes the instance in place.
    GroupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    ImageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    Name string
    Instance name.
    Networks List<CloudInstanceNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    ResourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    SecurityGroupIds List<string>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    Shares List<CloudInstanceShare>
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    UpdatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    VolumeIds List<string>
    IDs of block-storage volumes attached to the instance.
    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    Checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    CreatedAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    CurrentState CloudInstanceCurrentStateArgs
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    FlavorId string
    Flavor ID. Changing it resizes the instance in place.
    GroupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    ImageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    Name string
    Instance name.
    Networks []CloudInstanceNetworkArgs
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    ResourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    SecurityGroupIds []string
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    ServiceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    Shares []CloudInstanceShareArgs
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    UpdatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    VolumeIds []string
    IDs of block-storage volumes attached to the instance.
    availability_zone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    created_at string
    Creation date of the instance, as an RFC 3339 timestamp.
    current_state object
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    flavor_id string
    Flavor ID. Changing it resizes the instance in place.
    group_id string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    image_id string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name string
    Instance name.
    networks list(object)
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    resource_status string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    security_group_ids list(string)
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    service_name string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shares list(object)
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    updated_at string
    Last modification date of the instance, as an RFC 3339 timestamp.
    volume_ids list(string)
    IDs of block-storage volumes attached to the instance.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    checksum String
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt String
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    flavorId String
    Flavor ID. Changing it resizes the instance in place.
    groupId String
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId String
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name String
    Instance name.
    networks List<CloudInstanceNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    region String
    Region where the instance is created. Changing this value recreates the resource.
    resourceStatus String
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    securityGroupIds List<String>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shares List<CloudInstanceShare>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    updatedAt String
    Last modification date of the instance, as an RFC 3339 timestamp.
    volumeIds List<String>
    IDs of block-storage volumes attached to the instance.
    availabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    checksum string
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt string
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState CloudInstanceCurrentState
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    flavorId string
    Flavor ID. Changing it resizes the instance in place.
    groupId string
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId string
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name string
    Instance name.
    networks CloudInstanceNetwork[]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    resourceStatus string
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    securityGroupIds string[]
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    serviceName string
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shares CloudInstanceShare[]
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    updatedAt string
    Last modification date of the instance, as an RFC 3339 timestamp.
    volumeIds string[]
    IDs of block-storage volumes attached to the instance.
    availability_zone str
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    checksum str
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    created_at str
    Creation date of the instance, as an RFC 3339 timestamp.
    current_state CloudInstanceCurrentStateArgs
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    flavor_id str
    Flavor ID. Changing it resizes the instance in place.
    group_id str
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    image_id str
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name str
    Instance name.
    networks Sequence[CloudInstanceNetworkArgs]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state str
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    region str
    Region where the instance is created. Changing this value recreates the resource.
    resource_status str
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    security_group_ids Sequence[str]
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    service_name str
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shares Sequence[CloudInstanceShareArgs]
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name str
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    updated_at str
    Last modification date of the instance, as an RFC 3339 timestamp.
    volume_ids Sequence[str]
    IDs of block-storage volumes attached to the instance.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    checksum String
    Computed hash representing the current target specification value. It implements optimistic concurrency control: the value is echoed back on update and the request is rejected when it no longer matches server-side.
    createdAt String
    Creation date of the instance, as an RFC 3339 timestamp.
    currentState Property Map
    Observed state of the instance as reported by the compute backend, as opposed to the requested specification exposed at root level. Null while the instance is still being created and no backend state is available yet:
    flavorId String
    Flavor ID. Changing it resizes the instance in place.
    groupId String
    ID of the placement group the instance belongs to (immutable). This is the only way to make an instance a member of an ovh.CloudInstanceGroup. Changing this value recreates the resource.
    imageId String
    Image ID to boot from. Omit for a boot-from-volume instance. WARNING: changing it rebuilds the instance and wipes the root disk.
    name String
    Instance name.
    networks List<Property Map>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    region String
    Region where the instance is created. Changing this value recreates the resource.
    resourceStatus String
    Instance readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY, UPDATING). Distinct from current_state.power_state, which carries the lower-level OpenStack administrative power state.
    securityGroupIds List<String>
    IDs of security groups applied to all interfaces. Omit it to let the platform apply the project's default security group; set an explicit empty list ([]) to apply no security group at all (the instance then accepts no inbound traffic).
    serviceName String
    Service name of the resource representing the id of the cloud project. Changing this value recreates the resource.
    shares List<Property Map>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    updatedAt String
    Last modification date of the instance, as an RFC 3339 timestamp.
    volumeIds List<String>
    IDs of block-storage volumes attached to the instance.

    Supporting Types

    CloudInstanceCurrentState, CloudInstanceCurrentStateArgs

    Flavor CloudInstanceCurrentStateFlavor
    Observed flavor of the instance, with its full sizing details:
    Group CloudInstanceCurrentStateGroup
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    HostId string
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    Image CloudInstanceCurrentStateImage
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    Location CloudInstanceCurrentStateLocation
    Observed region and availability zone where the instance is provisioned:
    Locked bool
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    Name string
    Instance name.
    Networks List<CloudInstanceCurrentStateNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    ProjectId string
    Identifier of the Public Cloud project the instance belongs to.
    SecurityGroups List<CloudInstanceCurrentStateSecurityGroup>
    Security groups currently attached to the instance's ports:
    Shares List<CloudInstanceCurrentStateShare>
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    UserId string
    Identifier of the OpenStack user that owns the instance.
    Volumes List<CloudInstanceCurrentStateVolume>
    Observed block volumes attached to the instance:
    Flavor CloudInstanceCurrentStateFlavor
    Observed flavor of the instance, with its full sizing details:
    Group CloudInstanceCurrentStateGroup
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    HostId string
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    Image CloudInstanceCurrentStateImage
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    Location CloudInstanceCurrentStateLocation
    Observed region and availability zone where the instance is provisioned:
    Locked bool
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    Name string
    Instance name.
    Networks []CloudInstanceCurrentStateNetwork
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    PowerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    ProjectId string
    Identifier of the Public Cloud project the instance belongs to.
    SecurityGroups []CloudInstanceCurrentStateSecurityGroup
    Security groups currently attached to the instance's ports:
    Shares []CloudInstanceCurrentStateShare
    Filesystem shares attached to the instance. Each entry supports:
    SshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    UserId string
    Identifier of the OpenStack user that owns the instance.
    Volumes []CloudInstanceCurrentStateVolume
    Observed block volumes attached to the instance:
    flavor object
    Observed flavor of the instance, with its full sizing details:
    group object
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    host_id string
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    image object
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    location object
    Observed region and availability zone where the instance is provisioned:
    locked bool
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    name string
    Instance name.
    networks list(object)
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    project_id string
    Identifier of the Public Cloud project the instance belongs to.
    security_groups list(object)
    Security groups currently attached to the instance's ports:
    shares list(object)
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    user_id string
    Identifier of the OpenStack user that owns the instance.
    volumes list(object)
    Observed block volumes attached to the instance:
    flavor CloudInstanceCurrentStateFlavor
    Observed flavor of the instance, with its full sizing details:
    group CloudInstanceCurrentStateGroup
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    hostId String
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    image CloudInstanceCurrentStateImage
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    location CloudInstanceCurrentStateLocation
    Observed region and availability zone where the instance is provisioned:
    locked Boolean
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    name String
    Instance name.
    networks List<CloudInstanceCurrentStateNetwork>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    projectId String
    Identifier of the Public Cloud project the instance belongs to.
    securityGroups List<CloudInstanceCurrentStateSecurityGroup>
    Security groups currently attached to the instance's ports:
    shares List<CloudInstanceCurrentStateShare>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    userId String
    Identifier of the OpenStack user that owns the instance.
    volumes List<CloudInstanceCurrentStateVolume>
    Observed block volumes attached to the instance:
    flavor CloudInstanceCurrentStateFlavor
    Observed flavor of the instance, with its full sizing details:
    group CloudInstanceCurrentStateGroup
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    hostId string
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    image CloudInstanceCurrentStateImage
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    location CloudInstanceCurrentStateLocation
    Observed region and availability zone where the instance is provisioned:
    locked boolean
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    name string
    Instance name.
    networks CloudInstanceCurrentStateNetwork[]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState string
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    projectId string
    Identifier of the Public Cloud project the instance belongs to.
    securityGroups CloudInstanceCurrentStateSecurityGroup[]
    Security groups currently attached to the instance's ports:
    shares CloudInstanceCurrentStateShare[]
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName string
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    userId string
    Identifier of the OpenStack user that owns the instance.
    volumes CloudInstanceCurrentStateVolume[]
    Observed block volumes attached to the instance:
    flavor CloudInstanceCurrentStateFlavor
    Observed flavor of the instance, with its full sizing details:
    group CloudInstanceCurrentStateGroup
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    host_id str
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    image CloudInstanceCurrentStateImage
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    location CloudInstanceCurrentStateLocation
    Observed region and availability zone where the instance is provisioned:
    locked bool
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    name str
    Instance name.
    networks Sequence[CloudInstanceCurrentStateNetwork]
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    power_state str
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    project_id str
    Identifier of the Public Cloud project the instance belongs to.
    security_groups Sequence[CloudInstanceCurrentStateSecurityGroup]
    Security groups currently attached to the instance's ports:
    shares Sequence[CloudInstanceCurrentStateShare]
    Filesystem shares attached to the instance. Each entry supports:
    ssh_key_name str
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    user_id str
    Identifier of the OpenStack user that owns the instance.
    volumes Sequence[CloudInstanceCurrentStateVolume]
    Observed block volumes attached to the instance:
    flavor Property Map
    Observed flavor of the instance, with its full sizing details:
    group Property Map
    Instance (placement) group the instance belongs to, null when it is not part of any group:
    hostId String
    Opaque identifier of the physical host the instance is running on, as exposed by OpenStack. Null when not available.
    image Property Map
    Observed image the instance was booted from, null for a boot-from-volume instance which has no image:
    location Property Map
    Observed region and availability zone where the instance is provisioned:
    locked Boolean
    Whether the instance is locked against modifications. While locked, mutating actions are refused until it is unlocked.
    name String
    Instance name.
    networks List<Property Map>
    Network interfaces attached to the instance. Entries keep the order they are written in; the API returns them sorted by network id and the provider re-orders them back to the configuration. Four shapes:
    powerState String
    Desired power state: ACTIVE, SHUTOFF or SHELVED. When omitted, the API applies ACTIVE server-side and echoes it back; the provider declares no default of its own.
    projectId String
    Identifier of the Public Cloud project the instance belongs to.
    securityGroups List<Property Map>
    Security groups currently attached to the instance's ports:
    shares List<Property Map>
    Filesystem shares attached to the instance. Each entry supports:
    sshKeyName String
    Name of the SSH key injected at boot (immutable). Point it at the name of an ovh.CloudSSHKey. Changing this value recreates the resource.
    userId String
    Identifier of the OpenStack user that owns the instance.
    volumes List<Property Map>
    Observed block volumes attached to the instance:

    CloudInstanceCurrentStateFlavor, CloudInstanceCurrentStateFlavorArgs

    Disk int
    Size of the flavor's local root disk, in GB.
    Ephemeral int
    Size of the flavor's ephemeral disk, in GB.
    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Ram int
    Amount of RAM provided by the flavor, in MB.
    Swap int
    Size of the flavor's swap space, in MB.
    Vcpus int
    Number of virtual CPUs provided by the flavor.
    Disk int
    Size of the flavor's local root disk, in GB.
    Ephemeral int
    Size of the flavor's ephemeral disk, in GB.
    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Ram int
    Amount of RAM provided by the flavor, in MB.
    Swap int
    Size of the flavor's swap space, in MB.
    Vcpus int
    Number of virtual CPUs provided by the flavor.
    disk number
    Size of the flavor's local root disk, in GB.
    ephemeral number
    Size of the flavor's ephemeral disk, in GB.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    ram number
    Amount of RAM provided by the flavor, in MB.
    swap number
    Size of the flavor's swap space, in MB.
    vcpus number
    Number of virtual CPUs provided by the flavor.
    disk Integer
    Size of the flavor's local root disk, in GB.
    ephemeral Integer
    Size of the flavor's ephemeral disk, in GB.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    ram Integer
    Amount of RAM provided by the flavor, in MB.
    swap Integer
    Size of the flavor's swap space, in MB.
    vcpus Integer
    Number of virtual CPUs provided by the flavor.
    disk number
    Size of the flavor's local root disk, in GB.
    ephemeral number
    Size of the flavor's ephemeral disk, in GB.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    ram number
    Amount of RAM provided by the flavor, in MB.
    swap number
    Size of the flavor's swap space, in MB.
    vcpus number
    Number of virtual CPUs provided by the flavor.
    disk int
    Size of the flavor's local root disk, in GB.
    ephemeral int
    Size of the flavor's ephemeral disk, in GB.
    id str
    Identifier of the instance (placement) group.
    name str
    Instance name.
    ram int
    Amount of RAM provided by the flavor, in MB.
    swap int
    Size of the flavor's swap space, in MB.
    vcpus int
    Number of virtual CPUs provided by the flavor.
    disk Number
    Size of the flavor's local root disk, in GB.
    ephemeral Number
    Size of the flavor's ephemeral disk, in GB.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    ram Number
    Amount of RAM provided by the flavor, in MB.
    swap Number
    Size of the flavor's swap space, in MB.
    vcpus Number
    Number of virtual CPUs provided by the flavor.

    CloudInstanceCurrentStateGroup, CloudInstanceCurrentStateGroupArgs

    Id string
    Identifier of the instance (placement) group.
    Id string
    Identifier of the instance (placement) group.
    id string
    Identifier of the instance (placement) group.
    id String
    Identifier of the instance (placement) group.
    id string
    Identifier of the instance (placement) group.
    id str
    Identifier of the instance (placement) group.
    id String
    Identifier of the instance (placement) group.

    CloudInstanceCurrentStateImage, CloudInstanceCurrentStateImageArgs

    Deprecated bool
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Size int
    Size of the attached volume, in GB.
    Status string
    Lifecycle status of the image as reported by Glance.
    Deprecated bool
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Size int
    Size of the attached volume, in GB.
    Status string
    Lifecycle status of the image as reported by Glance.
    deprecated bool
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    size number
    Size of the attached volume, in GB.
    status string
    Lifecycle status of the image as reported by Glance.
    deprecated Boolean
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    size Integer
    Size of the attached volume, in GB.
    status String
    Lifecycle status of the image as reported by Glance.
    deprecated boolean
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    size number
    Size of the attached volume, in GB.
    status string
    Lifecycle status of the image as reported by Glance.
    deprecated bool
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    id str
    Identifier of the instance (placement) group.
    name str
    Instance name.
    size int
    Size of the attached volume, in GB.
    status str
    Lifecycle status of the image as reported by Glance.
    deprecated Boolean
    Whether the image is flagged as deprecated. A deprecated image still boots existing instances but is no longer recommended for new ones.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    size Number
    Size of the attached volume, in GB.
    status String
    Lifecycle status of the image as reported by Glance.

    CloudInstanceCurrentStateLocation, CloudInstanceCurrentStateLocationArgs

    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    AvailabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    Region string
    Region where the instance is created. Changing this value recreates the resource.
    availability_zone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    region String
    Region where the instance is created. Changing this value recreates the resource.
    availabilityZone string
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    region string
    Region where the instance is created. Changing this value recreates the resource.
    availability_zone str
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    region str
    Region where the instance is created. Changing this value recreates the resource.
    availabilityZone String
    Availability zone of the instance (immutable; assigned by the platform if omitted). Changing this value recreates the resource — only when it is set in the configuration; a value assigned by the platform is never treated as a change.
    region String
    Region where the instance is created. Changing this value recreates the resource.

    CloudInstanceCurrentStateNetwork, CloudInstanceCurrentStateNetworkArgs

    Addresses List<CloudInstanceCurrentStateNetworkAddress>
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    GatewayId string
    Identifier of the gateway providing egress for this interface, null when none applies.
    Id string
    Identifier of the instance (placement) group.
    SubnetId string
    Subnet ID within the private network. Required with network_id.
    Addresses []CloudInstanceCurrentStateNetworkAddress
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    GatewayId string
    Identifier of the gateway providing egress for this interface, null when none applies.
    Id string
    Identifier of the instance (placement) group.
    SubnetId string
    Subnet ID within the private network. Required with network_id.
    addresses list(object)
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    gateway_id string
    Identifier of the gateway providing egress for this interface, null when none applies.
    id string
    Identifier of the instance (placement) group.
    subnet_id string
    Subnet ID within the private network. Required with network_id.
    addresses List<CloudInstanceCurrentStateNetworkAddress>
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    gatewayId String
    Identifier of the gateway providing egress for this interface, null when none applies.
    id String
    Identifier of the instance (placement) group.
    subnetId String
    Subnet ID within the private network. Required with network_id.
    addresses CloudInstanceCurrentStateNetworkAddress[]
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    gatewayId string
    Identifier of the gateway providing egress for this interface, null when none applies.
    id string
    Identifier of the instance (placement) group.
    subnetId string
    Subnet ID within the private network. Required with network_id.
    addresses Sequence[CloudInstanceCurrentStateNetworkAddress]
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    gateway_id str
    Identifier of the gateway providing egress for this interface, null when none applies.
    id str
    Identifier of the instance (placement) group.
    subnet_id str
    Subnet ID within the private network. Required with network_id.
    addresses List<Property Map>
    Addresses observed on this interface: its fixed addresses plus, where applicable, its floating IP and any additional IPs routed to it. Each address carries a type of FIXED, FLOATING or ADDITIONAL:
    gatewayId String
    Identifier of the gateway providing egress for this interface, null when none applies.
    id String
    Identifier of the instance (placement) group.
    subnetId String
    Subnet ID within the private network. Required with network_id.

    CloudInstanceCurrentStateNetworkAddress, CloudInstanceCurrentStateNetworkAddressArgs

    Ip string
    IP address assigned to the interface (IPv4 or IPv6).
    Mac string
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    Type string
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    Version int
    IP version of the address (4 for IPv4, 6 for IPv6).
    Ip string
    IP address assigned to the interface (IPv4 or IPv6).
    Mac string
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    Type string
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    Version int
    IP version of the address (4 for IPv4, 6 for IPv6).
    ip string
    IP address assigned to the interface (IPv4 or IPv6).
    mac string
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    type string
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    version number
    IP version of the address (4 for IPv4, 6 for IPv6).
    ip String
    IP address assigned to the interface (IPv4 or IPv6).
    mac String
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    type String
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    version Integer
    IP version of the address (4 for IPv4, 6 for IPv6).
    ip string
    IP address assigned to the interface (IPv4 or IPv6).
    mac string
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    type string
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    version number
    IP version of the address (4 for IPv4, 6 for IPv6).
    ip str
    IP address assigned to the interface (IPv4 or IPv6).
    mac str
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    type str
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    version int
    IP version of the address (4 for IPv4, 6 for IPv6).
    ip String
    IP address assigned to the interface (IPv4 or IPv6).
    mac String
    MAC address of the interface this IP is bound to. Null when the backend reports no interface for the address, which happens for an additional IP routed to an instance whose public interface has no visible Ext-Net address yet.
    type String
    How this address reaches the instance: FIXED for an address assigned to the interface itself, FLOATING for a floating IP NAT'd onto it, ADDITIONAL for an additional IP routed to the public interface.
    version Number
    IP version of the address (4 for IPv4, 6 for IPv6).

    CloudInstanceCurrentStateSecurityGroup, CloudInstanceCurrentStateSecurityGroupArgs

    Id string
    Identifier of the instance (placement) group.
    Id string
    Identifier of the instance (placement) group.
    id string
    Identifier of the instance (placement) group.
    id String
    Identifier of the instance (placement) group.
    id string
    Identifier of the instance (placement) group.
    id str
    Identifier of the instance (placement) group.
    id String
    Identifier of the instance (placement) group.

    CloudInstanceCurrentStateShare, CloudInstanceCurrentStateShareArgs

    AccessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    AccessTo string
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    Id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    State string
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    AccessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    AccessTo string
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    Id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    State string
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    access_level string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    access_to string
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    state string
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    accessLevel String
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    accessTo String
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    id String
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    state String
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    accessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    accessTo string
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    state string
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    access_level str
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    access_to str
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    id str
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    state str
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.
    accessLevel String
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    accessTo String
    The instance IP address the Manila access rule targets: its fixed IPv4 address on the share's network.
    id String
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    state String
    Observed state of the underlying access rule (ACTIVE, APPLYING, DENYING, ERROR). Null while no state has been reported yet.

    CloudInstanceCurrentStateVolume, CloudInstanceCurrentStateVolumeArgs

    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Size int
    Size of the attached volume, in GB.
    Id string
    Identifier of the instance (placement) group.
    Name string
    Instance name.
    Size int
    Size of the attached volume, in GB.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    size number
    Size of the attached volume, in GB.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    size Integer
    Size of the attached volume, in GB.
    id string
    Identifier of the instance (placement) group.
    name string
    Instance name.
    size number
    Size of the attached volume, in GB.
    id str
    Identifier of the instance (placement) group.
    name str
    Instance name.
    size int
    Size of the attached volume, in GB.
    id String
    Identifier of the instance (placement) group.
    name String
    Instance name.
    size Number
    Size of the attached volume, in GB.

    CloudInstanceNetwork, CloudInstanceNetworkArgs

    AutoAssignPublicIp bool
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    Ip string
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    NetworkId string
    Private network ID. Omit for a public interface.
    SubnetId string
    Subnet ID within the private network. Required with network_id.
    AutoAssignPublicIp bool
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    Ip string
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    NetworkId string
    Private network ID. Omit for a public interface.
    SubnetId string
    Subnet ID within the private network. Required with network_id.
    auto_assign_public_ip bool
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    ip string
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    network_id string
    Private network ID. Omit for a public interface.
    subnet_id string
    Subnet ID within the private network. Required with network_id.
    autoAssignPublicIp Boolean
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    ip String
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    networkId String
    Private network ID. Omit for a public interface.
    subnetId String
    Subnet ID within the private network. Required with network_id.
    autoAssignPublicIp boolean
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    ip string
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    networkId string
    Private network ID. Omit for a public interface.
    subnetId string
    Subnet ID within the private network. Required with network_id.
    auto_assign_public_ip bool
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    ip str
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    network_id str
    Private network ID. Omit for a public interface.
    subnet_id str
    Subnet ID within the private network. Required with network_id.
    autoAssignPublicIp Boolean
    Attach a public interface with a public IP assigned by the platform. Only valid on an entry with no network_id and no ip, and on at most one entry.
    ip String
    IP address of this interface. Without network_id: a public IP the project already owns (additional IP, or an Ext-Net IP of the project in the instance's region). With network_id + subnet_id: pins the port's fixed address when inside the subnet CIDR, otherwise associates the existing floating IP with that address.
    networkId String
    Private network ID. Omit for a public interface.
    subnetId String
    Subnet ID within the private network. Required with network_id.

    CloudInstanceShare, CloudInstanceShareArgs

    Id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    AccessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    Id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    AccessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    access_level string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    id String
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    accessLevel String
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    id string
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    accessLevel string
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    id str
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    access_level str
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.
    id String
    Identifier of the file storage share to attach. Adding the reference attaches the share to the instance, removing it detaches it.
    accessLevel String
    Access level granted to the instance for this share: READ_ONLY or READ_WRITE. Omit it to let the API apply its default (READ_WRITE). When omitted, the attribute stays null in state even though the API echoes READ_WRITE back, so an omitted level never shows up as drift.

    Import

    An instance in a public cloud project can be imported using the service_name

    and instance_id, separated by /:

    terraform

    import {

    to = ovh_cloud_instance.instance

    id = “<service_name>/<instance_id>”

    }

    bash

    $ pulumi import ovh:index/cloudInstance:CloudInstance instance service_name/instance_id

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

    Package Details

    Repository
    ovh ovh/pulumi-ovh
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ovh Terraform Provider.
    ovh logo
    Viewing docs for OVHCloud v2.19.1
    published on Tuesday, Aug 18, 2026 by OVHcloud
    Schema (JSON)
    ovh/pulumi-ovh

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial