Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ComputeCapacityReservation

A template that defines the settings to use when creating compute capacity reservations.

Properties

availabilityDomain

availabilityDomain: string

The availability domain of the compute capacity reservation.

Example: {@code Uocm:PHX-AD-1}

compartmentId

compartmentId: string

The OCID of the compartment containing the compute capacity reservation.

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 compute capacity reservation.

Optional instanceReservationConfigs

instanceReservationConfigs: Array<InstanceReservationConfig>

The capacity configurations for the capacity reservation.

To use the reservation for the desired shape, specify the shape, count, and optionally the fault domain where you want this configuration.

Optional isDefaultReservation

isDefaultReservation: undefined | false | true

Whether this capacity reservation is the default. For more information, see Capacity Reservations.

lifecycleState

lifecycleState: LifecycleState

The current state of the compute capacity reservation.

Optional reservedInstanceCount

reservedInstanceCount: undefined | number

The number of instances for which capacity will be held with this compute capacity reservation. This number is the sum of the values of the {@code reservedCount} fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

timeCreated

timeCreated: Date

The date and time the compute capacity reservation was created, in the format defined by RFC3339.

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

Optional timeUpdated

timeUpdated: Date

The date and time the compute capacity reservation was updated, in the format defined by RFC3339.

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

Optional usedInstanceCount

usedInstanceCount: undefined | number

The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the {@code usedCount} fields for all of the instance capacity configurations under this reservation. The purpose of this field is to calculate the percentage usage of the reservation. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj