resourcePool

On this page
Back to index

Summary

A collection of resources with an ordering policy.
resourcePoolName
Stringrequired
Name for the resource pool; must be unique among all resource pools.
autoDelete
Stringoptional
If true, the pool is deleted when the last resource is deleted.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
newName
Stringoptional
The new name for an existing object that is being renamed.
orderingFilter
Stringoptional
JavaScript fragment that returns custom ordering of resources in a pool.
resourceNames
Stringoptional
List of resources to add/remove from the pool. (Alternate argument name resourceName.)
resourcePoolDisabled
Stringoptional
True means the resourcePool will not be allocated to job steps.
resourcePoolIdleSize
Stringoptional
Maximum number of resources to keep idle in the resource pool. If the system detects that the number of idle resources exceeds the maximum number specified, the additional idle resources are removed. Applicable only if the resource pool type is ELASTIC_K8S.
resourcePoolInactiveTimeout
Stringoptional
Timeout duration (in seconds) after which inactive resources are released from the pool; applicable only if the resource pool type is ELASTIC_K8S
resourcePoolMaxSize
Stringoptional
Maximum number of resources allowed in the resource pool; applicable only if the resource pool type is ELASTIC_K8S.
resourcePoolType
Stringoptional
Type of resource pool.

Usage

There are no usage examples available for resourcePool.