Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace InstancePool

An instance pool is a set of instances within the same region that are managed as a group. For more information about instance pools and instance configurations, see Managing Compute Instances.

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the instance pool.

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 displayName

displayName: undefined | string

A user-friendly name. Does not have to be unique, and it's changeable. 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\"}}

id

id: string

The OCID of the instance pool.

instanceConfigurationId

instanceConfigurationId: string

The OCID of the instance configuration associated with the instance pool.

Optional instanceDisplayNameFormatter

instanceDisplayNameFormatter: undefined | string

A user-friendly formatter for the instance pool's instances. Instance displaynames follow the format. The formatter does not retroactively change instance's displaynames, only instance displaynames in the future follow the format

Optional instanceHostnameFormatter

instanceHostnameFormatter: undefined | string

A user-friendly formatter for the instance pool's instances. Instance hostnames follow the format. The formatter does not retroactively change instance's hostnames, only instance hostnames in the future follow the format

lifecycleState

lifecycleState: LifecycleState

The current state of the instance pool.

Optional loadBalancers

The load balancers attached to the instance pool.

placementConfigurations

placementConfigurations: Array<InstancePoolPlacementConfiguration>

The placement configurations for the instance pool.

size

size: number

The number of instances that should be in the instance pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the instance pool was created, in the format defined by RFC3339. Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj