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

ovh.getCloudInstanceGroup

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

    Use this data source to retrieve information about an instance group (placement group) in a public cloud project. An instance group is immutable once created: there is no update route and its membership is fixed at instance-creation time.

    Example Usage

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

const group = ovh.getCloudInstanceGroup({
    serviceName: "<Public cloud project id>",
    id: "<instance group id>",
});
export const groupMemberIds = group.then(group => .map(member => (member.id)));

    import pulumi
import pulumi_ovh as ovh

group = ovh.get_cloud_instance_group(service_name="<Public cloud project id>",
    id="<instance group id>")
pulumi.export("groupMemberIds", [member.id for member in group.current_state.members])

    Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    var @group = Ovh.GetCloudInstanceGroup.Invoke(new()
    {
        ServiceName = "<Public cloud project id>",
        Id = "<instance group id>",
    });

    return new Dictionary<string, object?>
    {
        ["groupMemberIds"] = @group.Apply(@group => .Select(member => 
        {
            return member.Id;
        }).ToList()),
    };
});

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Using getCloudInstanceGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCloudInstanceGroup(args: GetCloudInstanceGroupArgs, opts?: InvokeOptions): Promise<GetCloudInstanceGroupResult>
function getCloudInstanceGroupOutput(args: GetCloudInstanceGroupOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudInstanceGroupResult>
    def get_cloud_instance_group(id: Optional[str] = None,
                             service_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetCloudInstanceGroupResult
def get_cloud_instance_group_output(id: pulumi.Input[Optional[str]] = None,
                             service_name: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudInstanceGroupResult]
    func LookupCloudInstanceGroup(ctx *Context, args *LookupCloudInstanceGroupArgs, opts ...InvokeOption) (*LookupCloudInstanceGroupResult, error)
func LookupCloudInstanceGroupOutput(ctx *Context, args *LookupCloudInstanceGroupOutputArgs, opts ...InvokeOption) LookupCloudInstanceGroupResultOutput

    > Note: This function is named LookupCloudInstanceGroup in the Go SDK.

    public static class GetCloudInstanceGroup 
{
    public static Task<GetCloudInstanceGroupResult> InvokeAsync(GetCloudInstanceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudInstanceGroupResult> Invoke(GetCloudInstanceGroupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudInstanceGroupResult> Invoke(GetCloudInstanceGroupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudInstanceGroupResult> getCloudInstanceGroup(GetCloudInstanceGroupArgs args, InvokeOptions options)
public static Output<GetCloudInstanceGroupResult> getCloudInstanceGroup(GetCloudInstanceGroupArgs args, InvokeOptions options)
public static Output<GetCloudInstanceGroupResult> getCloudInstanceGroup(GetCloudInstanceGroupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ovh:index/getCloudInstanceGroup:getCloudInstanceGroup
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_instance_group" "name" {
    # arguments
}

    The following arguments are supported:

    Id string
    Unique identifier of the instance group to look up.
    ServiceName string
    Service name of the resource representing the id of the cloud project.
    Id string
    Unique identifier of the instance group to look up.
    ServiceName string
    Service name of the resource representing the id of the cloud project.
    id string
    Unique identifier of the instance group to look up.
    service_name string
    Service name of the resource representing the id of the cloud project.
    id String
    Unique identifier of the instance group to look up.
    serviceName String
    Service name of the resource representing the id of the cloud project.
    id string
    Unique identifier of the instance group to look up.
    serviceName string
    Service name of the resource representing the id of the cloud project.
    id str
    Unique identifier of the instance group to look up.
    service_name str
    Service name of the resource representing the id of the cloud project.
    id String
    Unique identifier of the instance group to look up.
    serviceName String
    Service name of the resource representing the id of the cloud project.

    getCloudInstanceGroup Result

    The following output properties are available:

    Checksum string
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    CreatedAt string
    Timestamp at which the instance group was created, in RFC 3339 format.
    CurrentState GetCloudInstanceGroupCurrentState
    State of the instance group as observed on the backend:
    Id string
    Identifier of the member instance.
    Name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    Policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    Region string
    Region code.
    ResourceStatus string
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    ServiceName string
    Checksum string
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    CreatedAt string
    Timestamp at which the instance group was created, in RFC 3339 format.
    CurrentState GetCloudInstanceGroupCurrentState
    State of the instance group as observed on the backend:
    Id string
    Identifier of the member instance.
    Name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    Policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    Region string
    Region code.
    ResourceStatus string
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    ServiceName string
    checksum string
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    created_at string
    Timestamp at which the instance group was created, in RFC 3339 format.
    current_state object
    State of the instance group as observed on the backend:
    id string
    Identifier of the member instance.
    name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    region string
    Region code.
    resource_status string
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    service_name string
    checksum String
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    createdAt String
    Timestamp at which the instance group was created, in RFC 3339 format.
    currentState GetCloudInstanceGroupCurrentState
    State of the instance group as observed on the backend:
    id String
    Identifier of the member instance.
    name String
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy String
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    region String
    Region code.
    resourceStatus String
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    serviceName String
    checksum string
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    createdAt string
    Timestamp at which the instance group was created, in RFC 3339 format.
    currentState GetCloudInstanceGroupCurrentState
    State of the instance group as observed on the backend:
    id string
    Identifier of the member instance.
    name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    region string
    Region code.
    resourceStatus string
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    serviceName string
    checksum str
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    created_at str
    Timestamp at which the instance group was created, in RFC 3339 format.
    current_state GetCloudInstanceGroupCurrentState
    State of the instance group as observed on the backend:
    id str
    Identifier of the member instance.
    name str
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy str
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    region str
    Region code.
    resource_status str
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    service_name str
    checksum String
    Computed hash of the current target specification, used for optimistic concurrency control. Because an instance group has no update route, this value never changes after creation.
    createdAt String
    Timestamp at which the instance group was created, in RFC 3339 format.
    currentState Property Map
    State of the instance group as observed on the backend:
    id String
    Identifier of the member instance.
    name String
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy String
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    region String
    Region code.
    resourceStatus String
    Instance group readiness in the system (CREATING, DELETING, ERROR, OUT_OF_SYNC, READY). OUT_OF_SYNC means the group has drifted from its target specification; a group managed by ovh.CloudInstanceGroup is destroyed and recreated on the next pulumi up to converge.
    serviceName String

    Supporting Types

    GetCloudInstanceGroupCurrentState

    Location GetCloudInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    Members List<GetCloudInstanceGroupCurrentStateMember>
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    Name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    Policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    Location GetCloudInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    Members []GetCloudInstanceGroupCurrentStateMember
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    Name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    Policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    location object
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members list(object)
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    location GetCloudInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members List<GetCloudInstanceGroupCurrentStateMember>
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    name String
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy String
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    location GetCloudInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members GetCloudInstanceGroupCurrentStateMember[]
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    name string
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy string
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    location GetCloudInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members Sequence[GetCloudInstanceGroupCurrentStateMember]
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    name str
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy str
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.
    location Property Map
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members List<Property Map>
    Instances currently belonging to this group. Membership is determined at instance-creation time via the instance's group field and cannot be changed afterwards. Empty when the group has no member instances:
    name String
    Display name of the instance group as reported by the backend. Fixed for the lifetime of the group, since instance groups cannot be updated.
    policy String
    Placement policy currently enforced for the group's members (AFFINITY, ANTI_AFFINITY). Mirrors the underlying OpenStack/Nova server group policy and is fixed at creation.

    GetCloudInstanceGroupCurrentStateLocation

    AvailabilityZone string
    Availability zone within the region.
    Region string
    Region code.
    AvailabilityZone string
    Availability zone within the region.
    Region string
    Region code.
    availability_zone string
    Availability zone within the region.
    region string
    Region code.
    availabilityZone String
    Availability zone within the region.
    region String
    Region code.
    availabilityZone string
    Availability zone within the region.
    region string
    Region code.
    availability_zone str
    Availability zone within the region.
    region str
    Region code.
    availabilityZone String
    Availability zone within the region.
    region String
    Region code.

    GetCloudInstanceGroupCurrentStateMember

    Id string
    Unique identifier of the instance group to look up.
    Id string
    Unique identifier of the instance group to look up.
    id string
    Unique identifier of the instance group to look up.
    id String
    Unique identifier of the instance group to look up.
    id string
    Unique identifier of the instance group to look up.
    id str
    Unique identifier of the instance group to look up.
    id String
    Unique identifier of the instance group to look up.

    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