Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigquery
  5. CapacityCommitment
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.bigquery.CapacityCommitment

Explore with Pulumi AI

Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes.

In order to remove annual commitment, its plan needs to be changed to monthly or flex first.

To get more information about CapacityCommitment, see:

Example Usage

Bigquery Reservation Capacity Commitment Docs

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const example = new gcp.bigquery.CapacityCommitment("example", {
    capacityCommitmentId: "example-commitment",
    location: "us-west2",
    slotCount: 100,
    plan: "FLEX_FLAT_RATE",
    edition: "ENTERPRISE",
});
Copy
import pulumi
import pulumi_gcp as gcp

example = gcp.bigquery.CapacityCommitment("example",
    capacity_commitment_id="example-commitment",
    location="us-west2",
    slot_count=100,
    plan="FLEX_FLAT_RATE",
    edition="ENTERPRISE")
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigquery.NewCapacityCommitment(ctx, "example", &bigquery.CapacityCommitmentArgs{
			CapacityCommitmentId: pulumi.String("example-commitment"),
			Location:             pulumi.String("us-west2"),
			SlotCount:            pulumi.Int(100),
			Plan:                 pulumi.String("FLEX_FLAT_RATE"),
			Edition:              pulumi.String("ENTERPRISE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var example = new Gcp.BigQuery.CapacityCommitment("example", new()
    {
        CapacityCommitmentId = "example-commitment",
        Location = "us-west2",
        SlotCount = 100,
        Plan = "FLEX_FLAT_RATE",
        Edition = "ENTERPRISE",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.CapacityCommitment;
import com.pulumi.gcp.bigquery.CapacityCommitmentArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new CapacityCommitment("example", CapacityCommitmentArgs.builder()
            .capacityCommitmentId("example-commitment")
            .location("us-west2")
            .slotCount(100)
            .plan("FLEX_FLAT_RATE")
            .edition("ENTERPRISE")
            .build());

    }
}
Copy
resources:
  example:
    type: gcp:bigquery:CapacityCommitment
    properties:
      capacityCommitmentId: example-commitment
      location: us-west2
      slotCount: 100
      plan: FLEX_FLAT_RATE
      edition: ENTERPRISE
Copy

Create CapacityCommitment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CapacityCommitment(name: string, args: CapacityCommitmentArgs, opts?: CustomResourceOptions);
@overload
def CapacityCommitment(resource_name: str,
                       args: CapacityCommitmentArgs,
                       opts: Optional[ResourceOptions] = None)

@overload
def CapacityCommitment(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       plan: Optional[str] = None,
                       slot_count: Optional[int] = None,
                       capacity_commitment_id: Optional[str] = None,
                       edition: Optional[str] = None,
                       enforce_single_admin_project_per_org: Optional[str] = None,
                       location: Optional[str] = None,
                       project: Optional[str] = None,
                       renewal_plan: Optional[str] = None)
func NewCapacityCommitment(ctx *Context, name string, args CapacityCommitmentArgs, opts ...ResourceOption) (*CapacityCommitment, error)
public CapacityCommitment(string name, CapacityCommitmentArgs args, CustomResourceOptions? opts = null)
public CapacityCommitment(String name, CapacityCommitmentArgs args)
public CapacityCommitment(String name, CapacityCommitmentArgs args, CustomResourceOptions options)

type: gcp:bigquery:CapacityCommitment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CapacityCommitmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CapacityCommitmentArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityCommitmentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityCommitmentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CapacityCommitmentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var capacityCommitmentResource = new Gcp.BigQuery.CapacityCommitment("capacityCommitmentResource", new()
{
    Plan = "string",
    SlotCount = 0,
    CapacityCommitmentId = "string",
    Edition = "string",
    EnforceSingleAdminProjectPerOrg = "string",
    Location = "string",
    Project = "string",
    RenewalPlan = "string",
});
Copy
example, err := bigquery.NewCapacityCommitment(ctx, "capacityCommitmentResource", &bigquery.CapacityCommitmentArgs{
	Plan:                            pulumi.String("string"),
	SlotCount:                       pulumi.Int(0),
	CapacityCommitmentId:            pulumi.String("string"),
	Edition:                         pulumi.String("string"),
	EnforceSingleAdminProjectPerOrg: pulumi.String("string"),
	Location:                        pulumi.String("string"),
	Project:                         pulumi.String("string"),
	RenewalPlan:                     pulumi.String("string"),
})
Copy
var capacityCommitmentResource = new CapacityCommitment("capacityCommitmentResource", CapacityCommitmentArgs.builder()
    .plan("string")
    .slotCount(0)
    .capacityCommitmentId("string")
    .edition("string")
    .enforceSingleAdminProjectPerOrg("string")
    .location("string")
    .project("string")
    .renewalPlan("string")
    .build());
Copy
capacity_commitment_resource = gcp.bigquery.CapacityCommitment("capacityCommitmentResource",
    plan="string",
    slot_count=0,
    capacity_commitment_id="string",
    edition="string",
    enforce_single_admin_project_per_org="string",
    location="string",
    project="string",
    renewal_plan="string")
Copy
const capacityCommitmentResource = new gcp.bigquery.CapacityCommitment("capacityCommitmentResource", {
    plan: "string",
    slotCount: 0,
    capacityCommitmentId: "string",
    edition: "string",
    enforceSingleAdminProjectPerOrg: "string",
    location: "string",
    project: "string",
    renewalPlan: "string",
});
Copy
type: gcp:bigquery:CapacityCommitment
properties:
    capacityCommitmentId: string
    edition: string
    enforceSingleAdminProjectPerOrg: string
    location: string
    plan: string
    project: string
    renewalPlan: string
    slotCount: 0
Copy

CapacityCommitment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CapacityCommitment resource accepts the following input properties:

Plan This property is required. string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

SlotCount
This property is required.
Changes to this property will trigger replacement.
int
Number of slots in this commitment.
CapacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
Edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
EnforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
Location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RenewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
Plan This property is required. string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

SlotCount
This property is required.
Changes to this property will trigger replacement.
int
Number of slots in this commitment.
CapacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
Edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
EnforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
Location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RenewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
plan This property is required. String
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

slotCount
This property is required.
Changes to this property will trigger replacement.
Integer
Number of slots in this commitment.
capacityCommitmentId Changes to this property will trigger replacement. String
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
edition Changes to this property will trigger replacement. String
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. String
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. String
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan String
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
plan This property is required. string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

slotCount
This property is required.
Changes to this property will trigger replacement.
number
Number of slots in this commitment.
capacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
plan This property is required. str
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

slot_count
This property is required.
Changes to this property will trigger replacement.
int
Number of slots in this commitment.
capacity_commitment_id Changes to this property will trigger replacement. str
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
edition Changes to this property will trigger replacement. str
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforce_single_admin_project_per_org Changes to this property will trigger replacement. str
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. str
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewal_plan str
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
plan This property is required. String
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

slotCount
This property is required.
Changes to this property will trigger replacement.
Number
Number of slots in this commitment.
capacityCommitmentId Changes to this property will trigger replacement. String
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
edition Changes to this property will trigger replacement. String
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. String
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. String
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan String
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.

Outputs

All input properties are implicitly available as output properties. Additionally, the CapacityCommitment resource produces the following output properties:

CommitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
CommitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
State string
State of the commitment
CommitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
CommitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
State string
State of the commitment
commitmentEndTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
state String
State of the commitment
commitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
state string
State of the commitment
commitment_end_time str
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitment_start_time str
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
state str
State of the commitment
commitmentEndTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
state String
State of the commitment

Look up Existing CapacityCommitment Resource

Get an existing CapacityCommitment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: CapacityCommitmentState, opts?: CustomResourceOptions): CapacityCommitment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity_commitment_id: Optional[str] = None,
        commitment_end_time: Optional[str] = None,
        commitment_start_time: Optional[str] = None,
        edition: Optional[str] = None,
        enforce_single_admin_project_per_org: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        plan: Optional[str] = None,
        project: Optional[str] = None,
        renewal_plan: Optional[str] = None,
        slot_count: Optional[int] = None,
        state: Optional[str] = None) -> CapacityCommitment
func GetCapacityCommitment(ctx *Context, name string, id IDInput, state *CapacityCommitmentState, opts ...ResourceOption) (*CapacityCommitment, error)
public static CapacityCommitment Get(string name, Input<string> id, CapacityCommitmentState? state, CustomResourceOptions? opts = null)
public static CapacityCommitment get(String name, Output<String> id, CapacityCommitmentState state, CustomResourceOptions options)
resources:  _:    type: gcp:bigquery:CapacityCommitment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CapacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
CommitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
CommitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
EnforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
Location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
Plan string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RenewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
SlotCount Changes to this property will trigger replacement. int
Number of slots in this commitment.
State string
State of the commitment
CapacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
CommitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
CommitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
Edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
EnforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
Location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
Name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
Plan string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

Project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
RenewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
SlotCount Changes to this property will trigger replacement. int
Number of slots in this commitment.
State string
State of the commitment
capacityCommitmentId Changes to this property will trigger replacement. String
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
commitmentEndTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
edition Changes to this property will trigger replacement. String
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. String
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. String
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name String
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
plan String
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan String
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
slotCount Changes to this property will trigger replacement. Integer
Number of slots in this commitment.
state String
State of the commitment
capacityCommitmentId Changes to this property will trigger replacement. string
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
commitmentEndTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime string
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
edition Changes to this property will trigger replacement. string
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. string
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. string
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name string
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
plan string
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

project Changes to this property will trigger replacement. string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan string
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
slotCount Changes to this property will trigger replacement. number
Number of slots in this commitment.
state string
State of the commitment
capacity_commitment_id Changes to this property will trigger replacement. str
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
commitment_end_time str
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitment_start_time str
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
edition Changes to this property will trigger replacement. str
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforce_single_admin_project_per_org Changes to this property will trigger replacement. str
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. str
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name str
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
plan str
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

project Changes to this property will trigger replacement. str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewal_plan str
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
slot_count Changes to this property will trigger replacement. int
Number of slots in this commitment.
state str
State of the commitment
capacityCommitmentId Changes to this property will trigger replacement. String
The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
commitmentEndTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
commitmentStartTime String
The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
edition Changes to this property will trigger replacement. String
The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
enforceSingleAdminProjectPerOrg Changes to this property will trigger replacement. String
If true, fail the request if another project in the organization has a capacity commitment.
location Changes to this property will trigger replacement. String
The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
name String
The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123
plan String
Capacity commitment plan. Valid values are at https://cloud.google.com/bigquery/docs/reference/reservations/rpc/google.cloud.bigquery.reservation.v1#commitmentplan

project Changes to this property will trigger replacement. String
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
renewalPlan String
The plan this capacity commitment is converted to after commitmentEndTime passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for some commitment plans.
slotCount Changes to this property will trigger replacement. Number
Number of slots in this commitment.
state String
State of the commitment

Import

CapacityCommitment can be imported using any of these accepted formats:

  • projects/{{project}}/locations/{{location}}/capacityCommitments/{{capacity_commitment_id}}

  • {{project}}/{{location}}/{{capacity_commitment_id}}

  • {{location}}/{{capacity_commitment_id}}

When using the pulumi import command, CapacityCommitment can be imported using one of the formats above. For example:

$ pulumi import gcp:bigquery/capacityCommitment:CapacityCommitment default projects/{{project}}/locations/{{location}}/capacityCommitments/{{capacity_commitment_id}}
Copy
$ pulumi import gcp:bigquery/capacityCommitment:CapacityCommitment default {{project}}/{{location}}/{{capacity_commitment_id}}
Copy
$ pulumi import gcp:bigquery/capacityCommitment:CapacityCommitment default {{location}}/{{capacity_commitment_id}}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Google Cloud (GCP) Classic pulumi/pulumi-gcp
License
Apache-2.0
Notes
This Pulumi package is based on the google-beta Terraform Provider.
Google Cloud v8.25.1 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-gcp