Compute Commitment

A Compute Commitment in Google Cloud is a contract that provides discounted pricing in exchange for committing to use a specific amount of compute resources for a set period, typically one or three years. It helps reduce costs for predictable workloads by applying sustained-use discounts automatically to eligible virtual machine usage within the committed region and resource type.

gcp.compute_commitment

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
auto_renewcoreboolSpecifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.
categorycorestringThe category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.
creation_timestampcoretimestampOutput only. [Output Only] Creation timestamp inRFC3339 text format.
custom_end_timestampcorestring[Input Only] Optional, specifies the requested commitment end time inRFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.
datadog_display_namecorestring
descriptioncorestringAn optional description of the commitment. You can provide this property when you create the resource.
end_timestampcorestringOutput only. [Output Only] Commitment end time inRFC3339 text format.
existing_reservationscorearray<string>
gcp_statuscorestring[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, or EXPIRED. Possible values: ['ACTIVE', 'CANCELLED', 'CREATING', 'EXPIRED', 'NOT_YET_ACTIVE']. Values descriptions: ['', 'Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.', '', '', '']
idcorestringOutput only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
kindcorestringOutput only. [Output Only] Type of the resource. Always compute#commitment for commitments.
labelscorearray<string>
license_resourcecorejsonThe license specification required as part of a license commitment.
merge_source_commitmentscorearray<string>The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.
namecorestringName of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply withRFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
organization_idcorestring
parentcorestring
plancorestringThe minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).
project_idcorestring
project_numbercorestring
regioncorestringOutput only. [Output Only] URL of the region where the commitment and committed resources are located.
region_idcorestring
reservationscorejsonThe list of new reservations that you want to create and attach to this commitment. You must attach reservations to your commitment if your commitment specifies any GPUs or Local SSD disks. For more information, see Attach reservations to resource-based commitments. Specify this property only if you want to create new reservations to attach. To attach existing reservations, specify theexistingReservations property instead.
resource_namecorestring
resource_statuscorejsonOutput only. [Output Only] Status information for Commitment resource.
resourcescorejsonThe list of all the hardware resources, with their types and amounts, that you want to commit to. Specify as a separate entry in the list for each individual resource type.
self_linkcorestringOutput only. [Output Only] Server-defined URL for the resource.
split_source_commitmentcorestringThe source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.
start_timestampcorestringOutput only. [Output Only] Commitment start time inRFC3339 text format.
status_messagecorestringOutput only. [Output Only] An optional, human-readable explanation of the status.
tagscorehstore_csv
typecorestringThe type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types. The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.
zone_idcorestring