CcdCommitment

class oci.ccd_offers.models.CcdCommitment(**kwargs)

Bases: object

The created CCD commitment details.

Attributes:

LIFECYCLE_DETAILS_AWAITING_PROVISIONING

A constant which can be used with the lifecycle_details property of a CcdCommitment.

LIFECYCLE_DETAILS_CANCELED

A constant which can be used with the lifecycle_details property of a CcdCommitment.

LIFECYCLE_DETAILS_CURRENT

A constant which can be used with the lifecycle_details property of a CcdCommitment.

LIFECYCLE_DETAILS_ENDED

A constant which can be used with the lifecycle_details property of a CcdCommitment.

LIFECYCLE_DETAILS_SCHEDULED

A constant which can be used with the lifecycle_details property of a CcdCommitment.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a CcdCommitment.

approved_by

Gets the approved_by of this CcdCommitment.

compartment_id

[Required] Gets the compartment_id of this CcdCommitment.

created_by

Gets the created_by of this CcdCommitment.

defined_tags

Gets the defined_tags of this CcdCommitment.

display_name

[Required] Gets the display_name of this CcdCommitment.

filler_tenancy_home_region

Gets the filler_tenancy_home_region of this CcdCommitment.

filler_tenancy_id

Gets the filler_tenancy_id of this CcdCommitment.

freeform_tags

Gets the freeform_tags of this CcdCommitment.

id

[Required] Gets the id of this CcdCommitment.

last_updated_by

Gets the last_updated_by of this CcdCommitment.

lifecycle_details

Gets the lifecycle_details of this CcdCommitment.

lifecycle_state

Gets the lifecycle_state of this CcdCommitment.

offer_id

[Required] Gets the offer_id of this CcdCommitment.

quantity

[Required] Gets the quantity of this CcdCommitment.

reclaim_term

Gets the reclaim_term of this CcdCommitment.

reclaim_term_unit

Gets the reclaim_term_unit of this CcdCommitment.

secondary_skus

Gets the secondary_skus of this CcdCommitment.

sku_quantity_price_model

Gets the sku_quantity_price_model of this CcdCommitment.

source_type

[Required] Gets the source_type of this CcdCommitment.

subscription_id

[Required] Gets the subscription_id of this CcdCommitment.

system_tags

Gets the system_tags of this CcdCommitment.

time_ccd_commitment_ends

[Required] Gets the time_ccd_commitment_ends of this CcdCommitment.

time_ccd_commitment_starts

[Required] Gets the time_ccd_commitment_starts of this CcdCommitment.

time_created

Gets the time_created of this CcdCommitment.

time_terminated

Gets the time_terminated of this CcdCommitment.

time_updated

Gets the time_updated of this CcdCommitment.

usage_eligibility

Gets the usage_eligibility of this CcdCommitment.

Methods:

__init__(**kwargs)

Initializes a new CcdCommitment object with values from keyword arguments.

LIFECYCLE_DETAILS_AWAITING_PROVISIONING = 'AWAITING_PROVISIONING'

A constant which can be used with the lifecycle_details property of a CcdCommitment. This constant has a value of “AWAITING_PROVISIONING”

LIFECYCLE_DETAILS_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_details property of a CcdCommitment. This constant has a value of “CANCELED”

LIFECYCLE_DETAILS_CURRENT = 'CURRENT'

A constant which can be used with the lifecycle_details property of a CcdCommitment. This constant has a value of “CURRENT”

LIFECYCLE_DETAILS_ENDED = 'ENDED'

A constant which can be used with the lifecycle_details property of a CcdCommitment. This constant has a value of “ENDED”

LIFECYCLE_DETAILS_SCHEDULED = 'SCHEDULED'

A constant which can be used with the lifecycle_details property of a CcdCommitment. This constant has a value of “SCHEDULED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a CcdCommitment. This constant has a value of “ACTIVE”

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this CcdCommitment.

  • quantity (int) – The value to assign to the quantity property of this CcdCommitment.

  • display_name (str) – The value to assign to the display_name property of this CcdCommitment.

  • offer_id (str) – The value to assign to the offer_id property of this CcdCommitment.

  • source_type (str) – The value to assign to the source_type property of this CcdCommitment.

  • reclaim_term (int) – The value to assign to the reclaim_term property of this CcdCommitment.

  • reclaim_term_unit (str) – The value to assign to the reclaim_term_unit property of this CcdCommitment.

  • time_ccd_commitment_starts (datetime) – The value to assign to the time_ccd_commitment_starts property of this CcdCommitment.

  • time_ccd_commitment_ends (datetime) – The value to assign to the time_ccd_commitment_ends property of this CcdCommitment.

  • subscription_id (str) – The value to assign to the subscription_id property of this CcdCommitment.

  • compartment_id (str) – The value to assign to the compartment_id property of this CcdCommitment.

  • filler_tenancy_id (str) – The value to assign to the filler_tenancy_id property of this CcdCommitment.

  • filler_tenancy_home_region (str) – The value to assign to the filler_tenancy_home_region property of this CcdCommitment.

  • usage_eligibility (oci.ccd_offers.models.UsageEligibility) – The value to assign to the usage_eligibility property of this CcdCommitment.

  • secondary_skus (list[oci.ccd_offers.models.SecondarySkus]) – The value to assign to the secondary_skus property of this CcdCommitment.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this CcdCommitment. Allowed values for this property are: “ACTIVE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this CcdCommitment. Allowed values for this property are: “CURRENT”, “ENDED”, “CANCELED”, “SCHEDULED”, “AWAITING_PROVISIONING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • sku_quantity_price_model (list[oci.ccd_offers.models.CommittedSkuQuantityPriceModel]) – The value to assign to the sku_quantity_price_model property of this CcdCommitment.

  • time_created (datetime) – The value to assign to the time_created property of this CcdCommitment.

  • time_updated (datetime) – The value to assign to the time_updated property of this CcdCommitment.

  • time_terminated (datetime) – The value to assign to the time_terminated property of this CcdCommitment.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CcdCommitment.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CcdCommitment.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CcdCommitment.

  • last_updated_by (str) – The value to assign to the last_updated_by property of this CcdCommitment.

  • created_by (str) – The value to assign to the created_by property of this CcdCommitment.

  • approved_by (str) – The value to assign to the approved_by property of this CcdCommitment.

property approved_by

Gets the approved_by of this CcdCommitment. Entity/User who approved the ccdCommitment.

Returns

The approved_by of this CcdCommitment.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this CcdCommitment. The root compartment ID. The CCD Commitment is associated with the tenancy root compartment ID.

Returns

The compartment_id of this CcdCommitment.

Return type

str

property created_by

Gets the created_by of this CcdCommitment. The entity that created the CCD commitment.

Returns

The created_by of this CcdCommitment.

Return type

str

property defined_tags

Gets the defined_tags of this CcdCommitment. 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 CcdCommitment.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this CcdCommitment. The CCD commitment name. Ensure the name is unique for a given subscription ID. Avoid entering confidential information.

Returns

The display_name of this CcdCommitment.

Return type

str

property filler_tenancy_home_region

Gets the filler_tenancy_home_region of this CcdCommitment. The filler tenancy home region.

Returns

The filler_tenancy_home_region of this CcdCommitment.

Return type

str

property filler_tenancy_id

Gets the filler_tenancy_id of this CcdCommitment. The tenancy OCID that you want to apply filler usage to.

Returns

The filler_tenancy_id of this CcdCommitment.

Return type

str

property freeform_tags

Gets the freeform_tags of this CcdCommitment. 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 CcdCommitment.

Return type

dict(str, str)

property id

[Required] Gets the id of this CcdCommitment. The CCD commitment resource OCID.

Returns

The id of this CcdCommitment.

Return type

str

property last_updated_by

Gets the last_updated_by of this CcdCommitment. Entity/User who lastly updated the ccdCommitment.

Returns

The last_updated_by of this CcdCommitment.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this CcdCommitment. The CCD commitment’s current state. A commitment that’s expected to get a dedicated capacity will be in the Awaiting Provisioning state unless the commitment is ended or canceled. Otherwise, the value is determined by timeCcdCommitmentStarts, timeCcdCommitmentEnds, and timeTerminated, with respect to the current time.

Allowed values for this property are: “CURRENT”, “ENDED”, “CANCELED”, “SCHEDULED”, “AWAITING_PROVISIONING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_details of this CcdCommitment.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this CcdCommitment. This state always defaults to Active. For a detailed and exact state, check the lifecycleDetails state.

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

Returns

The lifecycle_state of this CcdCommitment.

Return type

str

property offer_id

[Required] Gets the offer_id of this CcdCommitment. The CCD offer OCID.

Returns

The offer_id of this CcdCommitment.

Return type

str

property quantity

[Required] Gets the quantity of this CcdCommitment. The hourly quantity that the customer is committing to a CCD offer’s main SKU. For example, if the quantity is 1000, then you are committing to a 1000 usage quantity value per hour.

Returns

The quantity of this CcdCommitment.

Return type

int

property reclaim_term

Gets the reclaim_term of this CcdCommitment. The reclaim term copied from the offer when the commitment is created. The value is measured in reclaimTermUnit.

Returns

The reclaim_term of this CcdCommitment.

Return type

int

property reclaim_term_unit

Gets the reclaim_term_unit of this CcdCommitment. The unit used to measure reclaimTerm, copied from the offer when the commitment is created.

Returns

The reclaim_term_unit of this CcdCommitment.

Return type

str

property secondary_skus

Gets the secondary_skus of this CcdCommitment. Secondary SKUs associated with the main SKU.

Returns

The secondary_skus of this CcdCommitment.

Return type

list[oci.ccd_offers.models.SecondarySkus]

property sku_quantity_price_model

Gets the sku_quantity_price_model of this CcdCommitment. The list of SKUs associated with the commitment and their prices in all currency codes.

Returns

The sku_quantity_price_model of this CcdCommitment.

Return type

list[oci.ccd_offers.models.CommittedSkuQuantityPriceModel]

property source_type

[Required] Gets the source_type of this CcdCommitment. The commercial workflow of the associated CCD offer.

Returns

The source_type of this CcdCommitment.

Return type

str

property subscription_id

[Required] Gets the subscription_id of this CcdCommitment. The subscription ID the CCD offer is applicable to.

Returns

The subscription_id of this CcdCommitment.

Return type

str

property system_tags

Gets the system_tags of this CcdCommitment. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this CcdCommitment.

Return type

dict(str, dict(str, object))

property time_ccd_commitment_ends

[Required] Gets the time_ccd_commitment_ends of this CcdCommitment. The date and time the CCD commitment will be deactivated. The date and time is calculated based on timeCcdCommitmentStarts, the term, and units of the CCD offer. For example: 2025-06-01T03:00:00. The format is defined by RFC 3339.

Returns

The time_ccd_commitment_ends of this CcdCommitment.

Return type

datetime

property time_ccd_commitment_starts

[Required] Gets the time_ccd_commitment_starts of this CcdCommitment. The date and time the CCD commitment will be effective.The format is defined by RFC 3339.

Returns

The time_ccd_commitment_starts of this CcdCommitment.

Return type

datetime

property time_created

Gets the time_created of this CcdCommitment. Date and time the CCD was created. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns

The time_created of this CcdCommitment.

Return type

datetime

property time_terminated

Gets the time_terminated of this CcdCommitment. Date and time the CCD was terminated. The format is defined by RFC 3339. Example: 2022-01-25T21:10:29.600Z

Returns

The time_terminated of this CcdCommitment.

Return type

datetime

property time_updated

Gets the time_updated of this CcdCommitment. Date and time the CCD was updated lastly. The format is defined by RFC 3339. Example: 2025-01-25T21:10:29.600Z

Returns

The time_updated of this CcdCommitment.

Return type

datetime

property usage_eligibility

Gets the usage_eligibility of this CcdCommitment.

Returns

The usage_eligibility of this CcdCommitment.

Return type

oci.ccd_offers.models.UsageEligibility