Show / Hide Table of Contents

Class 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.

Inheritance
object
InstancePool
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class InstancePool

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment containing the instance pool.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

DisplayName

Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, 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.
Example: {"Department": "Finance"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of the instance pool.

Remarks

Required

InstanceConfigurationId

Declaration
[Required(ErrorMessage = "InstanceConfigurationId is required.")]
[JsonProperty(PropertyName = "instanceConfigurationId")]
public string InstanceConfigurationId { get; set; }
Property Value
Type Description
string

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

Remarks

Required

InstanceDisplayNameFormatter

Declaration
[JsonProperty(PropertyName = "instanceDisplayNameFormatter")]
public string InstanceDisplayNameFormatter { get; set; }
Property Value
Type Description
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

InstanceHostnameFormatter

Declaration
[JsonProperty(PropertyName = "instanceHostnameFormatter")]
public string InstanceHostnameFormatter { get; set; }
Property Value
Type Description
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

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public InstancePool.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
InstancePool.LifecycleStateEnum?

The current state of the instance pool.

Remarks

Required

LoadBalancers

Declaration
[JsonProperty(PropertyName = "loadBalancers")]
public List<InstancePoolLoadBalancerAttachment> LoadBalancers { get; set; }
Property Value
Type Description
List<InstancePoolLoadBalancerAttachment>

The load balancers attached to the instance pool.

PlacementConfigurations

Declaration
[Required(ErrorMessage = "PlacementConfigurations is required.")]
[JsonProperty(PropertyName = "placementConfigurations")]
public List<InstancePoolPlacementConfiguration> PlacementConfigurations { get; set; }
Property Value
Type Description
List<InstancePoolPlacementConfiguration>

The placement configurations for the instance pool.

Remarks

Required

Size

Declaration
[Required(ErrorMessage = "Size is required.")]
[JsonProperty(PropertyName = "size")]
public int? Size { get; set; }
Property Value
Type Description
int?

The number of instances that should be in the instance pool.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

Remarks

Required

In this article
Back to top