Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace AutoScalingConfiguration

An autoscaling configuration lets you dynamically scale the resources in a Compute instance pool. For more information, see Autoscaling.

Properties

compartmentId

compartmentId: string

The OCID of the compartment containing the autoscaling configuration.

Optional coolDownInSeconds

coolDownInSeconds: undefined | number

For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default. The cooldown period starts when the instance pool reaches the running state.

For schedule-based autoscaling policies, this value is not used. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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 autoscaling configuration.

Optional isEnabled

isEnabled: undefined | false | true

Whether the autoscaling configuration is enabled.

Optional maxResourceCount

maxResourceCount: undefined | number

The maximum number of resources to scale out to. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional minResourceCount

minResourceCount: undefined | number

The minimum number of resources to scale in to. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

policies

policies: Array<AutoScalingPolicy>

Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.

resource

timeCreated

timeCreated: Date

The date and time the autoscaling configuration was created, in the format defined by RFC3339.

Example: {@code 2016-08-25T21:10:29.600Z}

Functions

getDeserializedJsonObj

getJsonObj