Skip to main content
Version: v3

ResourceInstance<T, I>

type ResourceInstance<T, I> = I & ResourceInstanceApi;

Represents a single resource instance returned from the Resources API.

Provides instance-level operations such as deleting or updating a resource instance. The resource data (metadata, spec, status, etc.) is accessible directly on the instance.

Type Parameters

T

T = any

Your specific resource type. Rancher will supplement the response with additional properties and methods

I

I = SteveResource<T>

The shape of the underlying resource data (defaults to SteveResource)

Example

import { useResources, K8S } from '@shell/apis';

const resources = useResources();
const pod = await resources.cluster.find(K8S.POD, 'default/my-pod-123');

// Access resource data directly
console.log(pod.metadata.name);

// Use instance operations
await pod.delete();