/** * Core Services API * Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](https://docs.oracle.com/iaas/Content/Network/Concepts/overview.htm), [Compute](https://docs.oracle.com/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](https://docs.oracle.com/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](https://docs.oracle.com/iaas/Content/Identity/Reference/corepolicyreference.htm) article. * OpenAPI spec version: 20160918 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2026, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import * as model from "../model"; /** * 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](https://docs.oracle.com/iaas/Content/Compute/Concepts/instancemanagement.htm). * */ export interface InstancePool { /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. */ "id": string; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the instance * pool. * */ "compartmentId": string; /** * Defined tags for this resource. Each key is predefined and scoped to a * namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}} * */ "definedTags"?: { [key: string]: { [key: string]: any; }; }; /** * A user-friendly name. Does not have to be unique, and it's changeable. * Avoid entering confidential information. * */ "displayName"?: string; /** * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). *

Example: {@code {\"Department\": \"Finance\"}} * */ "freeformTags"?: { [key: string]: string; }; /** * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration associated * with the instance pool. * */ "instanceConfigurationId": string; /** * The type of resources managed by the pool. * */ "poolType"?: InstancePool.PoolType; /** * The current state of the instance pool. */ "lifecycleState": InstancePool.LifecycleState; /** * The placement configurations for the instance pool. */ "placementConfigurations": Array; /** * The number of instances that should be in the instance pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "size": number; /** * The date and time the instance pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). * Example: {@code 2016-08-25T21:10:29.600Z} * */ "timeCreated": Date; /** * The load balancers attached to the instance pool. * */ "loadBalancers"?: Array; "overridePolicy"?: model.InstancePoolLaunchOverridePolicy; /** * 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 * */ "instanceDisplayNameFormatter"?: 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 * */ "instanceHostnameFormatter"?: string; "lifecycleManagement"?: model.InstancePoolLifecycleManagementDetails; /** * Count of instance in running state associated to the Instance Pool. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues. */ "currentSize"?: number; } export declare namespace InstancePool { enum PoolType { Instance = "INSTANCE", Gmc = "GMC", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } enum LifecycleState { Provisioning = "PROVISIONING", Scaling = "SCALING", Starting = "STARTING", Stopping = "STOPPING", Terminating = "TERMINATING", Stopped = "STOPPED", Terminated = "TERMINATED", Running = "RUNNING", /** * This value is used if a service returns a value for this enum that is not recognized by this * version of the SDK. */ UnknownValue = "UNKNOWN_VALUE" } function getJsonObj(obj: InstancePool): object; function getDeserializedJsonObj(obj: InstancePool): object; }