Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PoolResizeParameter

Package version

An interface representing PoolResizeParameter.

summary

Options for changing the size of a pool.

Hierarchy

  • PoolResizeParameter

Index

Properties

Optional nodeDeallocationOption

nodeDeallocationOption: ComputeNodeDeallocationOption

Determines what to do with a node and its running task(s) if the pool size is decreasing. The default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'

Optional resizeTimeout

resizeTimeout: undefined | string

The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. The default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Optional targetDedicatedNodes

targetDedicatedNodes: undefined | number

The desired number of dedicated compute nodes in the pool.

Optional targetLowPriorityNodes

targetLowPriorityNodes: undefined | number

The desired number of low-priority compute nodes in the pool.

Generated using TypeDoc