ComputeCapacityReservation¶

class oci.core.models.ComputeCapacityReservation(**kwargs)¶

Bases: object

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

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation.
`availability_domain`	[Required] Gets the availability_domain of this ComputeCapacityReservation.
`compartment_id`	[Required] Gets the compartment_id of this ComputeCapacityReservation.
`defined_tags`	Gets the defined_tags of this ComputeCapacityReservation.
`display_name`	Gets the display_name of this ComputeCapacityReservation.
`freeform_tags`	Gets the freeform_tags of this ComputeCapacityReservation.
`id`	[Required] Gets the id of this ComputeCapacityReservation.
`instance_reservation_configs`	Gets the instance_reservation_configs of this ComputeCapacityReservation.
`is_default_reservation`	Gets the is_default_reservation of this ComputeCapacityReservation.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ComputeCapacityReservation.
`reserved_instance_count`	Gets the reserved_instance_count of this ComputeCapacityReservation.
`time_created`	[Required] Gets the time_created of this ComputeCapacityReservation.
`time_updated`	Gets the time_updated of this ComputeCapacityReservation.
`used_instance_count`	Gets the used_instance_count of this ComputeCapacityReservation.

Methods

__init__(**kwargs) Initializes a new ComputeCapacityReservation object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “DELETING”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ComputeCapacityReservation. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ComputeCapacityReservation object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this ComputeCapacityReservation.
compartment_id (str) – The value to assign to the compartment_id property of this ComputeCapacityReservation.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ComputeCapacityReservation.
display_name (str) – The value to assign to the display_name property of this ComputeCapacityReservation.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ComputeCapacityReservation.
id (str) – The value to assign to the id property of this ComputeCapacityReservation.
is_default_reservation (bool) – The value to assign to the is_default_reservation property of this ComputeCapacityReservation.
instance_reservation_configs (list[oci.core.models.InstanceReservationConfig]) – The value to assign to the instance_reservation_configs property of this ComputeCapacityReservation.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ComputeCapacityReservation. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “MOVING”, “DELETED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
reserved_instance_count (int) – The value to assign to the reserved_instance_count property of this ComputeCapacityReservation.
time_updated (datetime) – The value to assign to the time_updated property of this ComputeCapacityReservation.
time_created (datetime) – The value to assign to the time_created property of this ComputeCapacityReservation.
used_instance_count (int) – The value to assign to the used_instance_count property of this ComputeCapacityReservation.

availability_domain¶

[Required] Gets the availability_domain of this ComputeCapacityReservation. The availability domain of the compute capacity reservation.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this ComputeCapacityReservation.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ComputeCapacityReservation. The OCID of the compartment containing the compute capacity reservation.

Returns:	The compartment_id of this ComputeCapacityReservation.
Return type:	str

defined_tags¶

Gets the defined_tags of this ComputeCapacityReservation. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this ComputeCapacityReservation.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this ComputeCapacityReservation. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this ComputeCapacityReservation.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ComputeCapacityReservation. 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”}

Returns:	The freeform_tags of this ComputeCapacityReservation.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ComputeCapacityReservation. The OCID of the compute capacity reservation.

Returns:	The id of this ComputeCapacityReservation.
Return type:	str

instance_reservation_configs¶

Gets the instance_reservation_configs of this ComputeCapacityReservation. 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.

Returns:	The instance_reservation_configs of this ComputeCapacityReservation.
Return type:	list[oci.core.models.InstanceReservationConfig]

is_default_reservation¶

Gets the is_default_reservation of this ComputeCapacityReservation. Whether this capacity reservation is the default. For more information, see Capacity Reservations.

Returns:	The is_default_reservation of this ComputeCapacityReservation.
Return type:	bool

lifecycle_state¶

[Required] Gets the lifecycle_state of this ComputeCapacityReservation. The current state of the compute capacity reservation.

Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “MOVING”, “DELETED”, “DELETING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this ComputeCapacityReservation.
Return type:	str

reserved_instance_count¶

Gets the reserved_instance_count of this ComputeCapacityReservation. 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 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.

Returns:	The reserved_instance_count of this ComputeCapacityReservation.
Return type:	int

time_created¶

[Required] Gets the time_created of this ComputeCapacityReservation. The date and time the compute capacity reservation was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this ComputeCapacityReservation.
Return type:	datetime

time_updated¶

Gets the time_updated of this ComputeCapacityReservation. The date and time the compute capacity reservation was updated, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this ComputeCapacityReservation.
Return type:	datetime

used_instance_count¶

Gets the used_instance_count of this ComputeCapacityReservation. The total number of instances currently consuming space in this compute capacity reservation. This number is the sum of the values of the 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.

Returns:	The used_instance_count of this ComputeCapacityReservation.
Return type:	int