Reservation

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

To get more information about Reservation, see:

API documentation
How-to Guides
- Introduction to Reservations

Create a Reservation Resource

new Reservation(name: string, args: ReservationArgs, opts?: CustomResourceOptions);

def Reservation(resource_name, opts=None, ignore_idle_slots=None, location=None, name=None, project=None, slot_capacity=None, __props__=None);

func NewReservation(ctx *Context, name string, args ReservationArgs, opts ...ResourceOption) (*Reservation, error)

public Reservation(string name, ReservationArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Reservation Resource Properties

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

Inputs

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.
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.

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.
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.

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.
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.

slot_capacity float: 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.
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.

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.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, ignore_idle_slots=None, location=None, name=None, project=None, slot_capacity=None, __props__=None);

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)

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.

The following state arguments are supported:

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.
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.

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.
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.

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.
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.

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.
slot_capacity float: 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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud