Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.bigqueryreservation/v1.Reservation
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Creates a new reservation resource.
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: Optional[ReservationArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Reservation(resource_name: str,
opts: Optional[ResourceOptions] = None,
autoscale: Optional[AutoscaleArgs] = None,
concurrency: Optional[str] = None,
edition: Optional[ReservationEdition] = None,
ignore_idle_slots: Optional[bool] = None,
location: Optional[str] = None,
multi_region_auxiliary: Optional[bool] = None,
name: Optional[str] = None,
project: Optional[str] = None,
reservation_id: Optional[str] = None,
slot_capacity: Optional[str] = None)
func NewReservation(ctx *Context, name string, args *ReservationArgs, opts ...ResourceOption) (*Reservation, error)
public Reservation(string name, ReservationArgs? args = null, CustomResourceOptions? opts = null)
public Reservation(String name, ReservationArgs args)
public Reservation(String name, ReservationArgs args, CustomResourceOptions options)
type: google-native:bigqueryreservation/v1: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 GoogleNative.BigQueryReservation.V1.Reservation("reservationResource", new()
{
Autoscale = new GoogleNative.BigQueryReservation.V1.Inputs.AutoscaleArgs
{
MaxSlots = "string",
},
Concurrency = "string",
Edition = GoogleNative.BigQueryReservation.V1.ReservationEdition.EditionUnspecified,
IgnoreIdleSlots = false,
Location = "string",
MultiRegionAuxiliary = false,
Name = "string",
Project = "string",
ReservationId = "string",
SlotCapacity = "string",
});
example, err := bigqueryreservation.NewReservation(ctx, "reservationResource", &bigqueryreservation.ReservationArgs{
Autoscale: &bigqueryreservation.AutoscaleArgs{
MaxSlots: pulumi.String("string"),
},
Concurrency: pulumi.String("string"),
Edition: bigqueryreservation.ReservationEditionEditionUnspecified,
IgnoreIdleSlots: pulumi.Bool(false),
Location: pulumi.String("string"),
MultiRegionAuxiliary: pulumi.Bool(false),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
ReservationId: pulumi.String("string"),
SlotCapacity: pulumi.String("string"),
})
var reservationResource = new Reservation("reservationResource", ReservationArgs.builder()
.autoscale(AutoscaleArgs.builder()
.maxSlots("string")
.build())
.concurrency("string")
.edition("EDITION_UNSPECIFIED")
.ignoreIdleSlots(false)
.location("string")
.multiRegionAuxiliary(false)
.name("string")
.project("string")
.reservationId("string")
.slotCapacity("string")
.build());
reservation_resource = google_native.bigqueryreservation.v1.Reservation("reservationResource",
autoscale={
"max_slots": "string",
},
concurrency="string",
edition=google_native.bigqueryreservation.v1.ReservationEdition.EDITION_UNSPECIFIED,
ignore_idle_slots=False,
location="string",
multi_region_auxiliary=False,
name="string",
project="string",
reservation_id="string",
slot_capacity="string")
const reservationResource = new google_native.bigqueryreservation.v1.Reservation("reservationResource", {
autoscale: {
maxSlots: "string",
},
concurrency: "string",
edition: google_native.bigqueryreservation.v1.ReservationEdition.EditionUnspecified,
ignoreIdleSlots: false,
location: "string",
multiRegionAuxiliary: false,
name: "string",
project: "string",
reservationId: "string",
slotCapacity: "string",
});
type: google-native:bigqueryreservation/v1:Reservation
properties:
autoscale:
maxSlots: string
concurrency: string
edition: EDITION_UNSPECIFIED
ignoreIdleSlots: false
location: string
multiRegionAuxiliary: false
name: string
project: string
reservationId: string
slotCapacity: string
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:
- Autoscale
Pulumi.
Google Native. Big Query Reservation. V1. Inputs. Autoscale - The configuration parameters for the auto scaling feature.
- Concurrency string
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - Edition
Pulumi.
Google Native. Big Query Reservation. V1. Reservation Edition - Edition of the reservation.
- Ignore
Idle boolSlots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- Location string
- Multi
Region boolAuxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- Name string
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - Project string
- Reservation
Id string - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- Slot
Capacity string - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
- Autoscale
Autoscale
Args - The configuration parameters for the auto scaling feature.
- Concurrency string
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - Edition
Reservation
Edition - Edition of the reservation.
- Ignore
Idle boolSlots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- Location string
- Multi
Region boolAuxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- Name string
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - Project string
- Reservation
Id string - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- Slot
Capacity string - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
- autoscale Autoscale
- The configuration parameters for the auto scaling feature.
- concurrency String
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - edition
Reservation
Edition - Edition of the reservation.
- ignore
Idle BooleanSlots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- location String
- multi
Region BooleanAuxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- name String
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - project String
- reservation
Id String - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- slot
Capacity String - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
- autoscale Autoscale
- The configuration parameters for the auto scaling feature.
- concurrency string
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - edition
Reservation
Edition - Edition of the reservation.
- ignore
Idle booleanSlots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- location string
- multi
Region booleanAuxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- name string
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - project string
- reservation
Id string - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- slot
Capacity string - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
- autoscale
Autoscale
Args - The configuration parameters for the auto scaling feature.
- concurrency str
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - edition
Reservation
Edition - Edition of the reservation.
- ignore_
idle_ boolslots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- location str
- multi_
region_ boolauxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- name str
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - project str
- reservation_
id str - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- slot_
capacity str - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
- autoscale Property Map
- The configuration parameters for the auto scaling feature.
- concurrency String
- Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as
target_job_concurrency
in the Information Schema, DDL and BQ CLI. - edition "EDITION_UNSPECIFIED" | "STANDARD" | "ENTERPRISE" | "ENTERPRISE_PLUS"
- Edition of the reservation.
- ignore
Idle BooleanSlots - If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
- location String
- multi
Region BooleanAuxiliary - Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field.
- name String
- The resource name of the reservation, e.g.,
projects/*/locations/*/reservations/team1-prod
. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. - project String
- reservation
Id String - The reservation ID. It must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
- slot
Capacity String - Baseline 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 ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with
google.rpc.Code.RESOURCE_EXHAUSTED
. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes.
Outputs
All input properties are implicitly available as output properties. Additionally, the Reservation resource produces the following output properties:
- Creation
Time string - Creation time of the reservation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - Last update time of the reservation.
- Creation
Time string - Creation time of the reservation.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - Last update time of the reservation.
- creation
Time String - Creation time of the reservation.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - Last update time of the reservation.
- creation
Time string - Creation time of the reservation.
- id string
- The provider-assigned unique ID for this managed resource.
- update
Time string - Last update time of the reservation.
- creation_
time str - Creation time of the reservation.
- id str
- The provider-assigned unique ID for this managed resource.
- update_
time str - Last update time of the reservation.
- creation
Time String - Creation time of the reservation.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - Last update time of the reservation.
Supporting Types
Autoscale, AutoscaleArgs
- Max
Slots string - Number of slots to be scaled when needed.
- Max
Slots string - Number of slots to be scaled when needed.
- max
Slots String - Number of slots to be scaled when needed.
- max
Slots string - Number of slots to be scaled when needed.
- max_
slots str - Number of slots to be scaled when needed.
- max
Slots String - Number of slots to be scaled when needed.
AutoscaleResponse, AutoscaleResponseArgs
- Current
Slots string - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- Max
Slots string - Number of slots to be scaled when needed.
- Current
Slots string - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- Max
Slots string - Number of slots to be scaled when needed.
- current
Slots String - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- max
Slots String - Number of slots to be scaled when needed.
- current
Slots string - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- max
Slots string - Number of slots to be scaled when needed.
- current_
slots str - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- max_
slots str - Number of slots to be scaled when needed.
- current
Slots String - The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
- max
Slots String - Number of slots to be scaled when needed.
ReservationEdition, ReservationEditionArgs
- Edition
Unspecified - EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- Standard
- STANDARDStandard edition.
- Enterprise
- ENTERPRISEEnterprise edition.
- Enterprise
Plus - ENTERPRISE_PLUSEnterprise plus edition.
- Reservation
Edition Edition Unspecified - EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- Reservation
Edition Standard - STANDARDStandard edition.
- Reservation
Edition Enterprise - ENTERPRISEEnterprise edition.
- Reservation
Edition Enterprise Plus - ENTERPRISE_PLUSEnterprise plus edition.
- Edition
Unspecified - EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- Standard
- STANDARDStandard edition.
- Enterprise
- ENTERPRISEEnterprise edition.
- Enterprise
Plus - ENTERPRISE_PLUSEnterprise plus edition.
- Edition
Unspecified - EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- Standard
- STANDARDStandard edition.
- Enterprise
- ENTERPRISEEnterprise edition.
- Enterprise
Plus - ENTERPRISE_PLUSEnterprise plus edition.
- EDITION_UNSPECIFIED
- EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- STANDARD
- STANDARDStandard edition.
- ENTERPRISE
- ENTERPRISEEnterprise edition.
- ENTERPRISE_PLUS
- ENTERPRISE_PLUSEnterprise plus edition.
- "EDITION_UNSPECIFIED"
- EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
- "STANDARD"
- STANDARDStandard edition.
- "ENTERPRISE"
- ENTERPRISEEnterprise edition.
- "ENTERPRISE_PLUS"
- ENTERPRISE_PLUSEnterprise plus edition.
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.