---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_compute_commitment{% #gcp_compute_commitment %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `auto_renew`{% #auto_renew %}

**Type**: `BOOLEAN`**Provider name**: `autoRenew`**Description**: Specifies 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.

## `category`{% #category %}

**Type**: `STRING`**Provider name**: `category`**Description**: The 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 as VCPU 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.**Possible values**:

- `CATEGORY_UNSPECIFIED`
- `LICENSE`
- `MACHINE`

## `creation_timestamp`{% #creation_timestamp %}

**Type**: `TIMESTAMP`**Provider name**: `creationTimestamp`**Description**: [Output Only] Creation timestamp in RFC3339 text format.

## `custom_end_timestamp`{% #custom_end_timestamp %}

**Type**: `STRING`**Provider name**: `customEndTimestamp`**Description**: [Input Only] Optional, specifies the requested commitment end time in RFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.

## `description`{% #description %}

**Type**: `STRING`**Provider name**: `description`**Description**: An optional description of the commitment. You can provide this property when you create the resource.

## `end_timestamp`{% #end_timestamp %}

**Type**: `STRING`**Provider name**: `endTimestamp`**Description**: [Output Only] Commitment end time in RFC3339 text format.

## `existing_reservations`{% #existing_reservations %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `existingReservations`

## `gcp_status`{% #gcp_status %}

**Type**: `STRING`**Provider name**: `status`**Description**: [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` - Deprecate CANCELED status. Will use separate status to differentiate cancel by mergeCud or manual cancellation.
- `CREATING`
- `EXPIRED`
- `NOT_YET_ACTIVE`

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: [Output Only] The unique identifier for the resource. This identifier is defined by the server.

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: [Output Only] Type of the resource. Always compute#commitment for commitments.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `license_resource`{% #license_resource %}

**Type**: `STRUCT`**Provider name**: `licenseResource`**Description**: The license specification required as part of a license commitment.

- `amount`**Type**: `INT64`**Provider name**: `amount`**Description**: The number of licenses you plan to purchase.
- `cores_per_license`**Type**: `STRING`**Provider name**: `coresPerLicense`**Description**: The number of cores per license.
- `license`**Type**: `STRING`**Provider name**: `license`**Description**: The applicable license URI.

## `merge_source_commitments`{% #merge_source_commitments %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `mergeSourceCommitments`**Description**: The list of source commitments that you are merging to create the new merged commitment. For more information, see Merging commitments.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply with RFC1035. 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_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `plan`{% #plan %}

**Type**: `STRING`**Provider name**: `plan`**Description**: The 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), and THIRTY_SIX_MONTH (3 years).**Possible values**:

- `INVALID`
- `THIRTY_SIX_MONTH`
- `TWELVE_MONTH`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `region`{% #region %}

**Type**: `STRING`**Provider name**: `region`**Description**: [Output Only] URL of the region where the commitment and committed resources are located.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `reservations`{% #reservations %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `reservations`**Description**: The 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 the existingReservations property instead.

- `aggregate_reservation`**Type**: `STRUCT`**Provider name**: `aggregateReservation`**Description**: Reservation for aggregated resources, providing shape flexibility.
  - `in_use_resources`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `inUseResources`**Description**: [Output only] List of resources currently in use.
    - `accelerator`**Type**: `STRUCT`**Provider name**: `accelerator`**Description**: Properties of accelerator resources in this reservation.
      - `accelerator_count`**Type**: `INT32`**Provider name**: `acceleratorCount`**Description**: Number of accelerators of specified type.
      - `accelerator_type`**Type**: `STRING`**Provider name**: `acceleratorType`**Description**: Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
  - `reserved_resources`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `reservedResources`**Description**: List of reserved resources (CPUs, memory, accelerators).
    - `accelerator`**Type**: `STRUCT`**Provider name**: `accelerator`**Description**: Properties of accelerator resources in this reservation.
      - `accelerator_count`**Type**: `INT32`**Provider name**: `acceleratorCount`**Description**: Number of accelerators of specified type.
      - `accelerator_type`**Type**: `STRING`**Provider name**: `acceleratorType`**Description**: Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
  - `vm_family`**Type**: `STRING`**Provider name**: `vmFamily`**Description**: The VM family that all instances scheduled against this reservation must belong to.**Possible values**:
    - `VM_FAMILY_CLOUD_TPU_DEVICE_CT3`
    - `VM_FAMILY_CLOUD_TPU_LITE_DEVICE_CT5L`
    - `VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT5LP`
    - `VM_FAMILY_CLOUD_TPU_LITE_POD_SLICE_CT6E`
    - `VM_FAMILY_CLOUD_TPU_POD_SLICE_CT3P`
    - `VM_FAMILY_CLOUD_TPU_POD_SLICE_CT4P`
    - `VM_FAMILY_CLOUD_TPU_POD_SLICE_CT5P`
  - `workload_type`**Type**: `STRING`**Provider name**: `workloadType`**Description**: The workload type of the instances that will target this reservation.**Possible values**:
    - `BATCH` - Reserved resources will be optimized for BATCH workloads, such as ML training.
    - `SERVING` - Reserved resources will be optimized for SERVING workloads, such as ML inference.
    - `UNSPECIFIED`
- `commitment`**Type**: `STRING`**Provider name**: `commitment`**Description**: [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
- `creation_timestamp`**Type**: `TIMESTAMP`**Provider name**: `creationTimestamp`**Description**: [Output Only] Creation timestamp in RFC3339 text format.
- `deployment_type`**Type**: `STRING`**Provider name**: `deploymentType`**Description**: Specifies the deployment strategy for this reservation.**Possible values**:
  - `DENSE` - The reserved capacity is made up of densely deployed reservation blocks.
  - `DEPLOYMENT_TYPE_UNSPECIFIED`
- `description`**Type**: `STRING`**Provider name**: `description`**Description**: An optional description of this resource. Provide this property when you create the resource.
- `gcp_status`**Type**: `STRING`**Provider name**: `status`**Description**: [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.**Possible values**:
  - `CREATING` - Reservation resources are being allocated.
  - `DELETING` - Reservation deletion is in progress.
  - `INVALID`
  - `READY` - Reservation resources have been allocated, and the reservation is ready for use.
  - `UPDATING` - Reservation update is in progress.
- `id`**Type**: `STRING`**Provider name**: `id`**Description**: [Output Only] The unique identifier for the resource. This identifier is defined by the server.
- `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: [Output Only] Type of the resource. Always compute#reservations for reservations.
- `linked_commitments`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `linkedCommitments`**Description**: [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. 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.
- `reservation_sharing_policy`**Type**: `STRUCT`**Provider name**: `reservationSharingPolicy`**Description**: Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
  - `service_share_type`**Type**: `STRING`**Provider name**: `serviceShareType`**Description**: Sharing config for all Google Cloud services.**Possible values**:
    - `ALLOW_ALL` - Allow all Google Cloud managed services to share reservations.
    - `DISALLOW_ALL` - [Default] Disallow sharing with all Google Cloud services.
    - `SERVICE_SHARE_TYPE_UNSPECIFIED`
- `resource_status`**Type**: `STRUCT`**Provider name**: `resourceStatus`**Description**: [Output Only] Status information for Reservation resource.
  - `reservation_block_count`**Type**: `INT32`**Provider name**: `reservationBlockCount`**Description**: The number of reservation blocks associated with this reservation.
  - `reservation_maintenance`**Type**: `STRUCT`**Provider name**: `reservationMaintenance`**Description**: Maintenance information for this reservation
    - `maintenance_ongoing_count`**Type**: `INT32`**Provider name**: `maintenanceOngoingCount`**Description**: Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
    - `maintenance_pending_count`**Type**: `INT32`**Provider name**: `maintenancePendingCount`**Description**: Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
    - `scheduling_type`**Type**: `STRING`**Provider name**: `schedulingType`**Description**: The type of maintenance for the reservation.**Possible values**:
      - `GROUPED` - Maintenance on all reserved instances in the reservation is synchronized.
      - `GROUP_MAINTENANCE_TYPE_UNSPECIFIED` - Unknown maintenance type.
      - `INDEPENDENT` - Maintenance is not synchronized for this reservation. Instead, each instance has its own maintenance window.
    - `upcoming_group_maintenance`**Type**: `STRUCT`**Provider name**: `upcomingGroupMaintenance`**Description**: Maintenance information on this group of VMs.
      - `can_reschedule`**Type**: `BOOLEAN`**Provider name**: `canReschedule`**Description**: Indicates if the maintenance can be customer triggered.
      - `latest_window_start_time`**Type**: `STRING`**Provider name**: `latestWindowStartTime`**Description**: The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
      - `maintenance_status`**Type**: `STRING`**Provider name**: `maintenanceStatus`
      - `type`**Type**: `STRING`**Provider name**: `type`**Description**: Defines the type of maintenance.**Possible values**:
        - `SCHEDULED` - Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).
        - `UNKNOWN_TYPE` - No type specified. Do not use this value.
        - `UNSCHEDULED` - Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee).
      - `window_end_time`**Type**: `STRING`**Provider name**: `windowEndTime`**Description**: The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
      - `window_start_time`**Type**: `STRING`**Provider name**: `windowStartTime`**Description**: The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
  - `specific_sku_allocation`**Type**: `STRUCT`**Provider name**: `specificSkuAllocation`**Description**: Allocation Properties of this reservation.
    - `source_instance_template_id`**Type**: `STRING`**Provider name**: `sourceInstanceTemplateId`**Description**: ID of the instance template used to populate reservation properties.
- `satisfies_pzs`**Type**: `BOOLEAN`**Provider name**: `satisfiesPzs`**Description**: [Output Only] Reserved for future use.
- `self_link`**Type**: `STRING`**Provider name**: `selfLink`**Description**: [Output Only] Server-defined fully-qualified URL for this resource.
- `share_settings`**Type**: `STRUCT`**Provider name**: `shareSettings`**Description**: Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
  - `share_type`**Type**: `STRING`**Provider name**: `shareType`**Description**: Type of sharing for this shared-reservation**Possible values**:
    - `LOCAL` - Default value.
    - `ORGANIZATION` - Shared-reservation is open to entire Organization
    - `SHARE_TYPE_UNSPECIFIED` - Default value. This value is unused.
    - `SPECIFIC_PROJECTS` - Shared-reservation is open to specific projects
- `specific_reservation`**Type**: `STRUCT`**Provider name**: `specificReservation`**Description**: Reservation for instances with specific machine shapes.
  - `assured_count`**Type**: `INT64`**Provider name**: `assuredCount`**Description**: [Output Only] Indicates how many instances are actually usable currently.
  - `count`**Type**: `INT64`**Provider name**: `count`**Description**: Specifies the number of resources that are allocated.
  - `in_use_count`**Type**: `INT64`**Provider name**: `inUseCount`**Description**: [Output Only] Indicates how many instances are in use.
  - `instance_properties`**Type**: `STRUCT`**Provider name**: `instanceProperties`**Description**: The instance properties for the reservation.
    - `guest_accelerators`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `guestAccelerators`**Description**: Specifies accelerator type and count.
      - `accelerator_count`**Type**: `INT32`**Provider name**: `acceleratorCount`**Description**: The number of the guest accelerator cards exposed to this instance.
      - `accelerator_type`**Type**: `STRING`**Provider name**: `acceleratorType`**Description**: Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
    - `local_ssds`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `localSsds`**Description**: Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
      - `disk_size_gb`**Type**: `INT64`**Provider name**: `diskSizeGb`**Description**: Specifies the size of the disk in base-2 GB.
      - `interface`**Type**: `STRING`**Provider name**: `interface`**Description**: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.**Possible values**:
        - `NVME`
        - `SCSI`
    - `location_hint`**Type**: `STRING`**Provider name**: `locationHint`**Description**: An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
    - `machine_type`**Type**: `STRING`**Provider name**: `machineType`**Description**: Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
    - `min_cpu_platform`**Type**: `STRING`**Provider name**: `minCpuPlatform`**Description**: Minimum cpu platform the reservation.
  - `source_instance_template`**Type**: `STRING`**Provider name**: `sourceInstanceTemplate`**Description**: Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - [https://www.googleapis.com/compute/v1/projects/project](https://www.googleapis.com/compute/v1/projects/project) /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
- `specific_reservation_required`**Type**: `BOOLEAN`**Provider name**: `specificReservationRequired`**Description**: Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
- `zone`**Type**: `STRING`**Provider name**: `zone`**Description**: Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `resource_status`{% #resource_status %}

**Type**: `STRUCT`**Provider name**: `resourceStatus`**Description**: [Output Only] Status information for Commitment resource.

- `custom_term_eligibility_end_timestamp`**Type**: `STRING`**Provider name**: `customTermEligibilityEndTimestamp`**Description**: [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.

## `resources`{% #resources %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `resources`**Description**: The 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.

- `accelerator_type`**Type**: `STRING`**Provider name**: `acceleratorType`**Description**: Name of the accelerator type or GPU resource. Specify this field only when the type of hardware resource is ACCELERATOR.
- `amount`**Type**: `INT64`**Provider name**: `amount`**Description**: The quantity of the hardware resource that you want to commit to purchasing (in a type-dependent unit). - For vCPUs, you must specify an integer value. - For memory, you specify the amount of MB that you want. The value you specify must be a multiple of 256 MB, with up to 6.5 GB of memory per every vCPU. - For GPUs, you must specify an integer value. - For Local SSD disks, you must specify the amount in GB. The size of a single Local SSD disk is 375 GB.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of hardware resource that you want to specify. You can specify any of the following values: - VCPU - MEMORY - LOCAL_SSD - ACCELERATOR Specify as a separate entry in the list for each individual resource type.**Possible values**:
  - `ACCELERATOR`
  - `LOCAL_SSD`
  - `MEMORY`
  - `UNSPECIFIED`
  - `VCPU`

## `self_link`{% #self_link %}

**Type**: `STRING`**Provider name**: `selfLink`**Description**: [Output Only] Server-defined URL for the resource.

## `split_source_commitment`{% #split_source_commitment %}

**Type**: `STRING`**Provider name**: `splitSourceCommitment`**Description**: The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

## `start_timestamp`{% #start_timestamp %}

**Type**: `STRING`**Provider name**: `startTimestamp`**Description**: [Output Only] Commitment start time in RFC3339 text format.

## `status_message`{% #status_message %}

**Type**: `STRING`**Provider name**: `statusMessage`**Description**: [Output Only] An optional, human-readable explanation of the status.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `type`{% #type %}

**Type**: `STRING`**Provider name**: `type`**Description**: The 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, 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.**Possible values**:

- `ACCELERATOR_OPTIMIZED`
- `ACCELERATOR_OPTIMIZED_A3`
- `ACCELERATOR_OPTIMIZED_A3_MEGA`
- `ACCELERATOR_OPTIMIZED_A3_ULTRA`
- `ACCELERATOR_OPTIMIZED_A4`
- `COMPUTE_OPTIMIZED`
- `COMPUTE_OPTIMIZED_C2D`
- `COMPUTE_OPTIMIZED_C3`
- `COMPUTE_OPTIMIZED_C3D`
- `COMPUTE_OPTIMIZED_H3`
- `GENERAL_PURPOSE`
- `GENERAL_PURPOSE_C4`
- `GENERAL_PURPOSE_C4A`
- `GENERAL_PURPOSE_E2`
- `GENERAL_PURPOSE_N2`
- `GENERAL_PURPOSE_N2D`
- `GENERAL_PURPOSE_N4`
- `GENERAL_PURPOSE_T2D`
- `GRAPHICS_OPTIMIZED`
- `MEMORY_OPTIMIZED`
- `MEMORY_OPTIMIZED_M3`
- `MEMORY_OPTIMIZED_M4`
- `MEMORY_OPTIMIZED_X4_16TB`
- `MEMORY_OPTIMIZED_X4_24TB`
- `MEMORY_OPTIMIZED_X4_32TB`
- `STORAGE_OPTIMIZED_Z3`
- `TYPE_UNSPECIFIED` - Note for internal users: When adding a new enum Type for v1, make sure to also add it in the comment for the `optional Type type` definition. This ensures that the public documentation displays the new enum Type.

## `zone_id`{% #zone_id %}

**Type**: `STRING`