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. Reservation
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.bigquery.Reservation

Explore with Pulumi AI

gcp logo
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-gcp

    A reservation is a mechanism used to guarantee BigQuery slots to users.

    To get more information about Reservation, see:

    Example Usage

    Bigquery Reservation Basic

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

const reservation = new gcp.bigquery.Reservation("reservation", {
    name: "my-reservation",
    location: "us-west2",
    slotCapacity: 0,
    edition: "STANDARD",
    ignoreIdleSlots: true,
    concurrency: 0,
    autoscale: {
        maxSlots: 100,
    },
});

    import pulumi
import pulumi_gcp as gcp

reservation = gcp.bigquery.Reservation("reservation",
    name="my-reservation",
    location="us-west2",
    slot_capacity=0,
    edition="STANDARD",
    ignore_idle_slots=True,
    concurrency=0,
    autoscale={
        "max_slots": 100,
    })

    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.NewReservation(ctx, "reservation", &bigquery.ReservationArgs{
			Name:            pulumi.String("my-reservation"),
			Location:        pulumi.String("us-west2"),
			SlotCapacity:    pulumi.Int(0),
			Edition:         pulumi.String("STANDARD"),
			IgnoreIdleSlots: pulumi.Bool(true),
			Concurrency:     pulumi.Int(0),
			Autoscale: &bigquery.ReservationAutoscaleArgs{
				MaxSlots: pulumi.Int(100),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var reservation = new Gcp.BigQuery.Reservation("reservation", new()
    {
        Name = "my-reservation",
        Location = "us-west2",
        SlotCapacity = 0,
        Edition = "STANDARD",
        IgnoreIdleSlots = true,
        Concurrency = 0,
        Autoscale = new Gcp.BigQuery.Inputs.ReservationAutoscaleArgs
        {
            MaxSlots = 100,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Reservation;
import com.pulumi.gcp.bigquery.ReservationArgs;
import com.pulumi.gcp.bigquery.inputs.ReservationAutoscaleArgs;
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 reservation = new Reservation("reservation", ReservationArgs.builder()
            .name("my-reservation")
            .location("us-west2")
            .slotCapacity(0)
            .edition("STANDARD")
            .ignoreIdleSlots(true)
            .concurrency(0)
            .autoscale(ReservationAutoscaleArgs.builder()
                .maxSlots(100)
                .build())
            .build());

    }
}

    resources:
  reservation:
    type: gcp:bigquery:Reservation
    properties:
      name: my-reservation
      location: us-west2
      slotCapacity: 0
      edition: STANDARD
      ignoreIdleSlots: true
      concurrency: 0
      autoscale:
        maxSlots: 100

    Create Reservation Resource

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

    Constructor syntax

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

@overload
def Reservation(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                slot_capacity: Optional[int] = None,
                autoscale: Optional[ReservationAutoscaleArgs] = None,
                concurrency: Optional[int] = None,
                edition: Optional[str] = None,
                ignore_idle_slots: Optional[bool] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                project: Optional[str] = None,
                secondary_location: Optional[str] = None)
    func NewReservation(ctx *Context, name string, args ReservationArgs, opts ...ResourceOption) (*Reservation, error)
    public Reservation(string name, ReservationArgs args, CustomResourceOptions? opts = null)
    public Reservation(String name, ReservationArgs args)
public Reservation(String name, ReservationArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ReservationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ReservationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ReservationArgs
    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 reservationResource = new Gcp.BigQuery.Reservation("reservationResource", new()
{
    SlotCapacity = 0,
    Autoscale = new Gcp.BigQuery.Inputs.ReservationAutoscaleArgs
    {
        CurrentSlots = 0,
        MaxSlots = 0,
    },
    Concurrency = 0,
    Edition = "string",
    IgnoreIdleSlots = false,
    Location = "string",
    Name = "string",
    Project = "string",
    SecondaryLocation = "string",
});

    example, err := bigquery.NewReservation(ctx, "reservationResource", &bigquery.ReservationArgs{
	SlotCapacity: pulumi.Int(0),
	Autoscale: &bigquery.ReservationAutoscaleArgs{
		CurrentSlots: pulumi.Int(0),
		MaxSlots:     pulumi.Int(0),
	},
	Concurrency:       pulumi.Int(0),
	Edition:           pulumi.String("string"),
	IgnoreIdleSlots:   pulumi.Bool(false),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Project:           pulumi.String("string"),
	SecondaryLocation: pulumi.String("string"),
})

    var reservationResource = new com.pulumi.gcp.bigquery.Reservation("reservationResource", com.pulumi.gcp.bigquery.ReservationArgs.builder()
    .slotCapacity(0)
    .autoscale(ReservationAutoscaleArgs.builder()
        .currentSlots(0)
        .maxSlots(0)
        .build())
    .concurrency(0)
    .edition("string")
    .ignoreIdleSlots(false)
    .location("string")
    .name("string")
    .project("string")
    .secondaryLocation("string")
    .build());

    reservation_resource = gcp.bigquery.Reservation("reservationResource",
    slot_capacity=0,
    autoscale={
        "current_slots": 0,
        "max_slots": 0,
    },
    concurrency=0,
    edition="string",
    ignore_idle_slots=False,
    location="string",
    name="string",
    project="string",
    secondary_location="string")

    const reservationResource = new gcp.bigquery.Reservation("reservationResource", {
    slotCapacity: 0,
    autoscale: {
        currentSlots: 0,
        maxSlots: 0,
    },
    concurrency: 0,
    edition: "string",
    ignoreIdleSlots: false,
    location: "string",
    name: "string",
    project: "string",
    secondaryLocation: "string",
});

    type: gcp:bigquery:Reservation
properties:
    autoscale:
        currentSlots: 0
        maxSlots: 0
    concurrency: 0
    edition: string
    ignoreIdleSlots: false
    location: string
    name: string
    project: string
    secondaryLocation: string
    slotCapacity: 0

    Reservation 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 Reservation resource accepts the following input properties:

    SlotCapacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    Autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    Concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    Edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    IgnoreIdleSlots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    Location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    Name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SecondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    SlotCapacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    Autoscale ReservationAutoscaleArgs
    The configuration parameters for the auto scaling feature. Structure is documented below.
    Concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    Edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    IgnoreIdleSlots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    Location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    Name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SecondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity Integer
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency Integer
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition String
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots Boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location String
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name String
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    secondaryLocation String
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity number
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency number
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    secondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slot_capacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscaleArgs
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition str
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignore_idle_slots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location str
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name str
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    secondary_location str
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity Number
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale Property Map
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency Number
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition String
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots Boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location String
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name String
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    secondaryLocation String
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    OriginalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    PrimaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    ReplicationStatuses List<ReservationReplicationStatus>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    OriginalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    PrimaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    ReplicationStatuses []ReservationReplicationStatus
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    originalPrimaryLocation String
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation String
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    replicationStatuses List<ReservationReplicationStatus>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    originalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    replicationStatuses ReservationReplicationStatus[]
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    original_primary_location str
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primary_location str
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    replication_statuses Sequence[ReservationReplicationStatus]
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    originalPrimaryLocation String
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation String
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    replicationStatuses List<Property Map>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.

    Look up Existing Reservation Resource

    Get an existing Reservation 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?: ReservationState, opts?: CustomResourceOptions): Reservation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        autoscale: Optional[ReservationAutoscaleArgs] = None,
        concurrency: Optional[int] = None,
        edition: Optional[str] = None,
        ignore_idle_slots: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        original_primary_location: Optional[str] = None,
        primary_location: Optional[str] = None,
        project: Optional[str] = None,
        replication_statuses: Optional[Sequence[ReservationReplicationStatusArgs]] = None,
        secondary_location: Optional[str] = None,
        slot_capacity: Optional[int] = None) -> Reservation
    func GetReservation(ctx *Context, name string, id IDInput, state *ReservationState, opts ...ResourceOption) (*Reservation, error)
    public static Reservation Get(string name, Input<string> id, ReservationState? state, CustomResourceOptions? opts = null)
    public static Reservation get(String name, Output<String> id, ReservationState state, CustomResourceOptions options)
    resources:  _:    type: gcp:bigquery:Reservation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    Concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    Edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    IgnoreIdleSlots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    Location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    Name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    OriginalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    PrimaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReplicationStatuses List<ReservationReplicationStatus>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    SecondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    SlotCapacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    Autoscale ReservationAutoscaleArgs
    The configuration parameters for the auto scaling feature. Structure is documented below.
    Concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    Edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    IgnoreIdleSlots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    Location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    Name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    OriginalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    PrimaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    ReplicationStatuses []ReservationReplicationStatusArgs
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    SecondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    SlotCapacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency Integer
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition String
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots Boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location String
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name String
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    originalPrimaryLocation String
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation String
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationStatuses List<ReservationReplicationStatus>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    secondaryLocation String
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity Integer
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscale
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency number
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition string
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location string
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name string
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    originalPrimaryLocation string
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation string
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationStatuses ReservationReplicationStatus[]
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    secondaryLocation string
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity number
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale ReservationAutoscaleArgs
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency int
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition str
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignore_idle_slots bool
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location str
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name str
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    original_primary_location str
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primary_location str
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replication_statuses Sequence[ReservationReplicationStatusArgs]
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    secondary_location str
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slot_capacity int
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.
    autoscale Property Map
    The configuration parameters for the auto scaling feature. Structure is documented below.
    concurrency Number
    Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
    edition String
    The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS
    ignoreIdleSlots Boolean
    If false, any query using this reservation will use idle slots from other reservations within the same admin project. If true, a query using this reservation will execute with the slot capacity specified above at most.
    location String
    The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.
    name String
    The name of the reservation. This field must only contain alphanumeric characters or dash.

    originalPrimaryLocation String
    The location where the reservation was originally created. This is set only during the failover reservation's creation. All billing charges for the failover reservation will be applied to this location.
    primaryLocation String
    The current location of the reservation's primary replica. This field is only set for reservations using the managed disaster recovery feature.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    replicationStatuses List<Property Map>
    The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded. Structure is documented below.
    secondaryLocation String
    The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).
    slotCapacity Number
    Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignoreIdleSlots is set to false.

    Supporting Types

    ReservationAutoscale, ReservationAutoscaleArgs

    CurrentSlots int
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    MaxSlots int
    Number of slots to be scaled when needed.
    CurrentSlots int
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    MaxSlots int
    Number of slots to be scaled when needed.
    currentSlots Integer
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots Integer
    Number of slots to be scaled when needed.
    currentSlots number
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots number
    Number of slots to be scaled when needed.
    current_slots int
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    max_slots int
    Number of slots to be scaled when needed.
    currentSlots Number
    (Output) The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots Number
    Number of slots to be scaled when needed.

    ReservationReplicationStatus, ReservationReplicationStatusArgs

    Errors List<ReservationReplicationStatusError>
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    LastErrorTime string
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    LastReplicationTime string
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.
    Errors []ReservationReplicationStatusError
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    LastErrorTime string
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    LastReplicationTime string
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.
    errors List<ReservationReplicationStatusError>
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    lastErrorTime String
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    lastReplicationTime String
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.
    errors ReservationReplicationStatusError[]
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    lastErrorTime string
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    lastReplicationTime string
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.
    errors Sequence[ReservationReplicationStatusError]
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    last_error_time str
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    last_replication_time str
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.
    errors List<Property Map>
    (Output) The last error encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since. Structure is documented below.
    lastErrorTime String
    (Output) The time at which the last error was encountered while trying to replicate changes from the primary to the secondary. This field is only available if the replication has not succeeded since.
    lastReplicationTime String
    (Output) A timestamp corresponding to the last change on the primary that was successfully replicated to the secondary.

    ReservationReplicationStatusError, ReservationReplicationStatusErrorArgs

    Code int
    (Output) The status code, which should be an enum value of google.rpc.Code.
    Message string
    (Output) A developer-facing error message, which should be in English.
    Code int
    (Output) The status code, which should be an enum value of google.rpc.Code.
    Message string
    (Output) A developer-facing error message, which should be in English.
    code Integer
    (Output) The status code, which should be an enum value of google.rpc.Code.
    message String
    (Output) A developer-facing error message, which should be in English.
    code number
    (Output) The status code, which should be an enum value of google.rpc.Code.
    message string
    (Output) A developer-facing error message, which should be in English.
    code int
    (Output) The status code, which should be an enum value of google.rpc.Code.
    message str
    (Output) A developer-facing error message, which should be in English.
    code Number
    (Output) The status code, which should be an enum value of google.rpc.Code.
    message String
    (Output) A developer-facing error message, which should be in English.

    Import

    Reservation can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/reservations/{{name}}

    • {{project}}/{{location}}/{{name}}

    • {{location}}/{{name}}

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

    $ pulumi import gcp:bigquery/reservation:Reservation default projects/{{project}}/locations/{{location}}/reservations/{{name}}

    $ pulumi import gcp:bigquery/reservation:Reservation default {{project}}/{{location}}/{{name}}

    $ pulumi import gcp:bigquery/reservation:Reservation default {{location}}/{{name}}

    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.
    gcp logo
    Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-gcp