Skip to main content

GetInstancePoolResource

Type Alias GetInstancePoolResource 

Source
pub type GetInstancePoolResource = InstancePool;

Aliased Type§

pub struct GetInstancePoolResource {
Show 24 fields pub subnets: Vec<ResourceRef>, pub vpc: InstancePoolVpc, pub autoscaling: Option<AutoscalingPolicy>, pub autoscaling_status: Option<AutoscalingStatus>, pub rollout_surge: Option<bool>, pub scale_in_protected_instances: Option<Vec<String>>, pub scale_in_blocked_reason: Option<String>, pub retiring_instances: Option<Vec<RetiringPoolMember>>, pub id: Option<String>, pub crn: Option<String>, pub name: Option<String>, pub description: Option<String>, pub desired_count: Option<i64>, pub min_count: Option<i64>, pub max_count: Option<i64>, pub live_count: Option<i64>, pub member_count: Option<i64>, pub refresh_in_progress: Option<bool>, pub stale_instance_count: Option<i64>, pub status: Option<InstancePoolStatus>, pub faults: Vec<Fault>, pub managed_by: Option<String>, pub tags: Option<BTreeMap<String, String>>, pub template: Option<InstancePoolTemplate>,
}

Fields§

§subnets: Vec<ResourceRef>

Eligible placement subnets in the same account, region and VPC.

§vpc: InstancePoolVpc§autoscaling: Option<AutoscalingPolicy>§autoscaling_status: Option<AutoscalingStatus>§rollout_surge: Option<bool>

Temporary rollout capacity; desired_count remains the steady target.

§scale_in_protected_instances: Option<Vec<String>>

Instance UUIDs protected from manual and automatic scale-in. Protection does not prevent refresh, failed-instance replacement, or explicit deletion.

§scale_in_blocked_reason: Option<String>

Why scale-in protection currently prevents the requested reduction. Omitted when not blocked.

§retiring_instances: Option<Vec<RetiringPoolMember>>§id: Option<String>§crn: Option<String>

Cloud Resource Name. This is the value an IAM policy statement must name to scope a permission to this pool alone; a policy written against anything else will not match.

§name: Option<String>

Resource names must not start with the literal crn: prefix or be UUIDs (canonical, compact, braced, or urn:uuid: forms, in either case).

§description: Option<String>§desired_count: Option<i64>§min_count: Option<i64>§max_count: Option<i64>

A value of 0 means the pool holds no members until max_count is raised.

§live_count: Option<i64>

How many members are UP — bound instances whose current_state is running.

§member_count: Option<i64>

How many instances the pool holds, running or not. This is what the reconciler converges toward desired_count and what status reflects, so member_count == desired_count with live_count below it means the pool has the members it was asked for and some of them are not up.

§refresh_in_progress: Option<bool>

True while a rolling replacement requested through POST /v1/instance-pools/{pool_id}/refresh is still running. It clears itself once every member is on the current template. The pool reads scaling for the duration, since it runs one instance over its target while a replacement comes up.

§stale_instance_count: Option<i64>

How many members were launched from a template other than the pool’s current one — that is, how many a refresh would replace. Non-zero after editing template and before refreshing, which is the signal that a template change has not been rolled out yet.

§status: Option<InstancePoolStatus>

Where the pool is against its target. active means member_count == desired_count — the pool holds the members it was asked for. It is not a claim that all of them are up; read live_count for that. scaling means it does not, and the reconciler is converging it: after a create, after a desired_count change, and for the length of an instance refresh, which runs the pool one instance over its target while a replacement comes up. error means an active error fault exists. Capacity failures remain eligible for reconciliation; failed deletion retains its teardown intent and never recreates members. deleting is teardown without an active error.

§faults: Vec<Fault>

Active faults, newest first. Empty for a healthy pool. Recovery resolves only the successful operation’s codes.

§managed_by: Option<String>§tags: Option<BTreeMap<String, String>>

Labels on the POOL itself, for IAM conditions (basalt:ResourceTag/<key>) and cost attribution. They are attached to nothing else: no instance the pool launches carries them. The tags a replica is launched with are template.tags. Unlike the other top-level fields beside this one, tags is not a projection of the launch template — it is the pool’s own set, and PATCHable on its own.

§template: Option<InstancePoolTemplate>

The pool’s launch config, in the shape instance create takes. The only place it appears: a flat copy of it beside this was two spellings of one thing, and two spellings drift.