Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace UpdatePoolDetails

The details required to update a given pool with {@code poolId}.

Properties

Functions

Properties

Optional configurations

configurations: Array<PoolConfig>

List of PoolConfig items.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

A user-friendly description. Avoid entering confidential information.

Optional displayName

displayName: undefined | string

A user-friendly name. It does not have to be unique. Avoid entering confidential information.

Optional freeformTags

freeformTags: undefined | object

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

Optional idleTimeoutInMinutes

idleTimeoutInMinutes: undefined | number

Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional schedules

schedules: Array<PoolSchedule>

A list of schedules for pool to auto start and stop.

Functions

getDeserializedJsonObj

getJsonObj