# KubernetesNodePools Object

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

Schema for the `KubernetesNodePools` 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 node pool name, verbatim.
- **`status`** _(string)_
  State, normalised. failed: creating or deleting the pool failed (on AWS EKS: CREATE_FAILED, DELETE_FAILED). degraded: the pool runs but has a health issue - see health_issue_codes. provider_status has the provider's value verbatim.
  Allowed: `creating`, `active`, `updating`, `deleting`, `failed`, `degraded`, `unknown`
- **`provider_status`** _(string)_
  The provider's own state string, verbatim (on AWS EKS: CREATING, ACTIVE, UPDATING, DELETING, CREATE_FAILED, DELETE_FAILED, DEGRADED).
- **`cluster`** _(object)_
  The Kubernetes cluster the pool belongs to.
  - **`id`** _(string)_
    The target's `id`.
- **`kubernetes_version`** _(string)_
  The Kubernetes version of the nodes, verbatim. It can lag the cluster's kubernetes_version after a control-plane upgrade.
- **`node_image_version`** _(string)_
  The node image release, verbatim (on AWS EKS: the AMI release version, for example 1.31.0-20241011).
- **`node_image_type`** _(string)_
  The node image family, verbatim (on AWS EKS: the AMI type, for example AL2023_x86_64_STANDARD, BOTTLEROCKET_ARM_64, CUSTOM).
- **`capacity_type`** _(string)_
  How the nodes are bought, normalised. spot: spare capacity the provider can take back at short notice (Azure Spot, GCP Spot VMs). reserved_capacity: capacity booked ahead for a fixed period (on AWS: EC2 Capacity Blocks, CAPACITY_BLOCK). provider_capacity_type has the value verbatim.
  Allowed: `on_demand`, `spot`, `reserved_capacity`, `unknown`
- **`provider_capacity_type`** _(string)_
  How the nodes are bought, verbatim (on AWS EKS: ON_DEMAND, SPOT or CAPACITY_BLOCK).
- **`instance_types`** _(array<string>)_
  Instance types the pool launches.
- **`disk_size_gb`** _(integer)_
  Root volume size in GiB. Null when a launch template sets the disk.
- **`min_size`** _(integer)_
  Minimum node count.
- **`max_size`** _(integer)_
  Maximum node count.
- **`desired_size`** _(integer)_
  Desired node count.
- **`remote_access_enabled`** _(boolean)_
  Whether SSH (RDP on Windows) access to the nodes is configured with a key.
- **`remote_access_open_to_internet`** _(boolean)_
  True when remote access is configured with a key but no source rule sets: the provider then opens the port to 0.0.0.0/0.
- **`remote_access_source_rule_sets`** _(array<object>)_
  The firewall rule sets (security groups) allowed to reach the nodes over SSH/RDP.
  - **`id`** _(string)_
    The target's `id`.
- **`node_role`** _(object)_
  The role the nodes run as.
  - **`id`** _(string)_
    The target's `id`.
- **`subnet_ids`** _(array<string>)_
  Subnets the nodes are placed in.
- **`launch_template_id`** _(string)_
  The launch template the pool uses, when one is set.
- **`health_issue_codes`** _(array<string>)_
  Codes of the provider's current health issues for the pool. Empty means healthy.

## Methods

- [GET /unified/cloud-infrastructure/kubernetes_node_pools/{id}](/docs/api-reference/unified-cloud-infrastructure-api/kubernetesnodepools/get) — Get Kubernetes node pools
- [GET /unified/cloud-infrastructure/kubernetes_node_pools](/docs/api-reference/unified-cloud-infrastructure-api/kubernetesnodepools/list) — List Kubernetes node pools