# InstanceGroups Object

> Source: https://truto.one/docs/api-reference/unified-cloud-infrastructure-api/instancegroups/

Schema for the `InstanceGroups` resource in **Unified Cloud Infrastructure API**.

## Properties

- **`id`** _(string, required)_
  Truto's stable unified identifier for this object. Opaque; use provider_id to address the object in the provider's own console or API.
- **`provider_id`** _(string)_
  The provider's own identifier, passed through verbatim — a full ARN, resource id, or self-link. Never truncated, prefixed, or normalized.
- **`provider`** _(string)_
  Which cloud this object was read from.
  Allowed: `aws`, `azure`, `gcp`
- **`account`** _(string)_
  The account, subscription or project this object belongs to.
- **`region`** _(string)_
  Where the object is located. 'global' denotes genuinely global resources (e.g. IAM, GCP VPC networks) rather than a guessed region. A substituted region (when none is derivable) is flagged in unreadable_fields.
- **`native_type`** _(string)_
  The provider's own type string, unmodified — for example 'AWS::S3::Bucket', 'aws_iam_role', 'Microsoft.Sql/servers'. Used for display and drill-down.
- **`tags`** _(object)_
  Key-value pairs exactly as the customer set them: no case folding, key/value normalization, or merging of separate provider concepts. An empty object means no tags; tags that could not be read appear in unreadable_fields instead.
- **`collected_at`** _(string)_
  When Truto actually read this object from the provider, in UTC ISO 8601 with the offset present — not the request time, and not a provider timestamp.
- **`updated_at`** _(string)_
  When the object was last modified at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`created_at`** _(string)_
  When the object was created at the provider, in UTC ISO 8601. Null when the provider does not record one - see unreadable_fields.
- **`unreadable_fields`** _(array<object>)_
  Fields on this object that could not be read, and why. An empty array means everything was read. Use this to tell a real value from a missing one.
  - **`field`** _(string)_
    The property on this resource that could not be read.
  - **`reason`** _(string)_
    Why the field could not be read. available_on_get: Not read on list to keep the list fast; call GET for this resource's id to get it.
    Allowed: `not_supported_by_provider`, `not_configured`, `permission_denied`, `not_collected`, `collection_error`, `partially_collected`, `available_on_get`
  - **`detail`** _(string)_
    Explanation of the reason, where one adds anything.
- **`remote_data`** _(object)_
  Raw data returned from the remote API call.
- **`name`** _(string)_
  The group's name, verbatim.
- **`min_size`** _(integer)_
  Fewest machines the group keeps.
- **`max_size`** _(integer)_
  Most machines the group may run.
- **`desired_size`** _(integer)_
  How many machines the group is trying to run right now.
- **`availability_zones`** _(array<string>)_
  Zones the group may launch into.
- **`subnet_ids`** _(array<string>)_
  Subnets the group launches into.
- **`health_check_types`** _(array<string>)_
  Health checks that decide when a machine is replaced, normalised. instance: the provider's machine status checks (on AWS EC2); load_balancer: load balancer target health (ELB); service_network: service network target health (VPC Lattice); block_volume: attached volume health (EBS). instance alone means a machine failing a load balancer check is not replaced. The provider's own value is in remote_data.
- **`health_check_grace_period_seconds`** _(integer)_
  How long a new machine is spared from health checks.
- **`launch_template_id`** _(string)_
  The launch template the group launches from (on AWS an lt- id, also when it comes from a mixed instances policy). Null when the group uses a legacy launch configuration.
- **`launch_template_version`** _(string)_
  The template version the group uses, verbatim ($Latest, $Default or a number on AWS).
- **`uses_legacy_launch_configuration`** _(boolean)_
  Whether the group launches from a legacy launch definition the provider no longer extends (an AWS launch configuration). False on providers without one.
- **`instances`** _(array<object>)_
  Machines currently in the group.
  - **`instance`** _(object)_
    The machine.
    - **`id`** _(string)_
      The target's `id`.
  - **`instance_id`** _(string)_
    The machine's own id, verbatim.
  - **`availability_zone`** _(string)_
    Zone the machine runs in.
  - **`instance_type`** _(string)_
    Machine type, verbatim.
  - **`health_status`** _(string)_
    The group's health verdict for the machine. The provider's own value is in remote_data.
    Allowed: `healthy`, `unhealthy`, `unknown`
  - **`lifecycle_state`** _(string)_
    Where the machine is in the group lifecycle, normalised. pending and terminating include their lifecycle-hook wait steps; warm_pool: a pre-initialised machine in the warm pool; standby: taken out of service but kept in the group. The provider's own value is in remote_data.
    Allowed: `pending`, `in_service`, `standby`, `detaching`, `detached`, `terminating`, `terminated`, `warm_pool`, `unknown`
  - **`protected_from_scale_in`** _(boolean)_
    Whether scale-in may not remove this machine.
- **`load_balancer_target_ids`** _(array<string>)_
  Load balancer target groups (ARNs) and classic load balancer names the group registers its machines with.
- **`suspended_processes`** _(array<string>)_
  Scaling processes that are suspended, verbatim (Launch, Terminate, HealthCheck, ReplaceUnhealthy ... on AWS). A suspended HealthCheck or ReplaceUnhealthy stops unhealthy machines being replaced.
- **`service_role`** _(object)_
  The identity the scaling service acts as (on AWS the service-linked role).
  - **`id`** _(string)_
    The target's `id`.
- **`status`** _(string)_
  deleting while the group is being deleted; null otherwise. The provider's own value is in remote_data.
  Allowed: `deleting`, `unknown`

## Methods

- [GET /unified/cloud-infrastructure/instance_groups/{id}](/docs/api-reference/unified-cloud-infrastructure-api/instancegroups/get) — Get Instance groups
- [GET /unified/cloud-infrastructure/instance_groups](/docs/api-reference/unified-cloud-infrastructure-api/instancegroups/list) — List Instance groups