Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AutoPoolSpecification

Package version

An interface representing AutoPoolSpecification.

summary

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted.

Hierarchy

  • AutoPoolSpecification

Index

Properties

Optional autoPoolIdPrefix

autoPoolIdPrefix: undefined | string

A prefix to be added to the unique identifier when a pool is automatically created. The Batch service assigns each auto pool a unique identifier on creation. To distinguish between pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long.

Optional keepAlive

keepAlive: undefined | false | true

Whether to keep an auto pool alive after its lifetime expires. If false, the Batch service deletes the pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the job or job schedule completes. If true, the Batch service does not delete the pool automatically. It is up to the user to delete auto pools created with this option.

Optional pool

The pool specification for the auto pool.

poolLifetimeOption

poolLifetimeOption: PoolLifetimeOption

The minimum lifetime of created auto pools, and how multiple jobs on a schedule are assigned to pools. Possible values include: 'jobSchedule', 'job'

Generated using TypeDoc