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

ovh.getCloudInstanceGroups

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 list the instance groups (placement groups) of 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.

    Using getCloudInstanceGroups

    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 getCloudInstanceGroups(args: GetCloudInstanceGroupsArgs, opts?: InvokeOptions): Promise<GetCloudInstanceGroupsResult>
function getCloudInstanceGroupsOutput(args: GetCloudInstanceGroupsOutputArgs, opts?: InvokeOutputOptions): Output<GetCloudInstanceGroupsResult>
    def get_cloud_instance_groups(service_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCloudInstanceGroupsResult
def get_cloud_instance_groups_output(service_name: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetCloudInstanceGroupsResult]
    func GetCloudInstanceGroups(ctx *Context, args *GetCloudInstanceGroupsArgs, opts ...InvokeOption) (*GetCloudInstanceGroupsResult, error)
func GetCloudInstanceGroupsOutput(ctx *Context, args *GetCloudInstanceGroupsOutputArgs, opts ...InvokeOption) GetCloudInstanceGroupsResultOutput

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

    public static class GetCloudInstanceGroups 
{
    public static Task<GetCloudInstanceGroupsResult> InvokeAsync(GetCloudInstanceGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudInstanceGroupsResult> Invoke(GetCloudInstanceGroupsInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetCloudInstanceGroupsResult> Invoke(GetCloudInstanceGroupsInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetCloudInstanceGroupsResult> getCloudInstanceGroups(GetCloudInstanceGroupsArgs args, InvokeOptions options)
public static Output<GetCloudInstanceGroupsResult> getCloudInstanceGroups(GetCloudInstanceGroupsArgs args, InvokeOptions options)
public static Output<GetCloudInstanceGroupsResult> getCloudInstanceGroups(GetCloudInstanceGroupsArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: ovh:index/getCloudInstanceGroups:getCloudInstanceGroups
  arguments:
    # arguments dictionary
    data "ovh_get_cloud_instance_groups" "name" {
    # arguments
}

    The following arguments are supported:

    ServiceName string
    Service name of the resource representing the id of the cloud project.
    ServiceName string
    Service name of the resource representing the id of the cloud project.
    service_name string
    Service name of the resource representing the id of the cloud project.
    serviceName String
    Service name of the resource representing the id of the cloud project.
    serviceName string
    Service name of the resource representing the id of the cloud project.
    service_name str
    Service name of the resource representing the id of the cloud project.
    serviceName String
    Service name of the resource representing the id of the cloud project.

    getCloudInstanceGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceGroups List<GetCloudInstanceGroupsInstanceGroup>
    Instance groups (placement groups) belonging to the project, across every region:
    ServiceName string
    Id string
    The provider-assigned unique ID for this managed resource.
    InstanceGroups []GetCloudInstanceGroupsInstanceGroup
    Instance groups (placement groups) belonging to the project, across every region:
    ServiceName string
    id string
    The provider-assigned unique ID for this managed resource.
    instance_groups list(object)
    Instance groups (placement groups) belonging to the project, across every region:
    service_name string
    id String
    The provider-assigned unique ID for this managed resource.
    instanceGroups List<GetCloudInstanceGroupsInstanceGroup>
    Instance groups (placement groups) belonging to the project, across every region:
    serviceName String
    id string
    The provider-assigned unique ID for this managed resource.
    instanceGroups GetCloudInstanceGroupsInstanceGroup[]
    Instance groups (placement groups) belonging to the project, across every region:
    serviceName string
    id str
    The provider-assigned unique ID for this managed resource.
    instance_groups Sequence[GetCloudInstanceGroupsInstanceGroup]
    Instance groups (placement groups) belonging to the project, across every region:
    service_name str
    id String
    The provider-assigned unique ID for this managed resource.
    instanceGroups List<Property Map>
    Instance groups (placement groups) belonging to the project, across every region:
    serviceName String

    Supporting Types

    GetCloudInstanceGroupsInstanceGroup

    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 GetCloudInstanceGroupsInstanceGroupCurrentState
    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.
    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 GetCloudInstanceGroupsInstanceGroupCurrentState
    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.
    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.
    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 GetCloudInstanceGroupsInstanceGroupCurrentState
    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.
    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 GetCloudInstanceGroupsInstanceGroupCurrentState
    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.
    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 GetCloudInstanceGroupsInstanceGroupCurrentState
    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.
    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.

    GetCloudInstanceGroupsInstanceGroupCurrentState

    Location GetCloudInstanceGroupsInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    Members List<GetCloudInstanceGroupsInstanceGroupCurrentStateMember>
    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 GetCloudInstanceGroupsInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    Members []GetCloudInstanceGroupsInstanceGroupCurrentStateMember
    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 GetCloudInstanceGroupsInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members List<GetCloudInstanceGroupsInstanceGroupCurrentStateMember>
    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 GetCloudInstanceGroupsInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members GetCloudInstanceGroupsInstanceGroupCurrentStateMember[]
    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 GetCloudInstanceGroupsInstanceGroupCurrentStateLocation
    Region (and, where applicable, availability zone) where the instance group and its member instances are deployed, as observed on the backend:
    members Sequence[GetCloudInstanceGroupsInstanceGroupCurrentStateMember]
    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.

    GetCloudInstanceGroupsInstanceGroupCurrentStateLocation

    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.

    GetCloudInstanceGroupsInstanceGroupCurrentStateMember

    Id string
    Identifier of the member instance.
    Id string
    Identifier of the member instance.
    id string
    Identifier of the member instance.
    id String
    Identifier of the member instance.
    id string
    Identifier of the member instance.
    id str
    Identifier of the member instance.
    id String
    Identifier of the member instance.

    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