1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigqueryreservation
  5. bigqueryreservation/v1beta1
  6. Reservation

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.bigqueryreservation/v1beta1.Reservation

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    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,
                    concurrency: Optional[str] = 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/v1beta1: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 google_nativeReservationResource = new GoogleNative.BigQueryReservation.V1Beta1.Reservation("google-nativeReservationResource", new()
    {
        Concurrency = "string",
        IgnoreIdleSlots = false,
        Location = "string",
        MultiRegionAuxiliary = false,
        Name = "string",
        Project = "string",
        ReservationId = "string",
        SlotCapacity = "string",
    });
    
    example, err := bigqueryreservationv1beta1.NewReservation(ctx, "google-nativeReservationResource", &bigqueryreservationv1beta1.ReservationArgs{
    Concurrency: pulumi.String("string"),
    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 google_nativeReservationResource = new Reservation("google-nativeReservationResource", ReservationArgs.builder()
        .concurrency("string")
        .ignoreIdleSlots(false)
        .location("string")
        .multiRegionAuxiliary(false)
        .name("string")
        .project("string")
        .reservationId("string")
        .slotCapacity("string")
        .build());
    
    google_native_reservation_resource = google_native.bigqueryreservation.v1beta1.Reservation("google-nativeReservationResource",
        concurrency="string",
        ignore_idle_slots=False,
        location="string",
        multi_region_auxiliary=False,
        name="string",
        project="string",
        reservation_id="string",
        slot_capacity="string")
    
    const google_nativeReservationResource = new google_native.bigqueryreservation.v1beta1.Reservation("google-nativeReservationResource", {
        concurrency: "string",
        ignoreIdleSlots: false,
        location: "string",
        multiRegionAuxiliary: false,
        name: "string",
        project: "string",
        reservationId: "string",
        slotCapacity: "string",
    });
    
    type: google-native:bigqueryreservation/v1beta1:Reservation
    properties:
        concurrency: string
        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

    The Reservation resource accepts the following input properties:

    Concurrency string
    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.
    IgnoreIdleSlots bool
    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
    MultiRegionAuxiliary bool
    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.
    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
    ReservationId 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.
    SlotCapacity string
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
    Concurrency string
    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.
    IgnoreIdleSlots bool
    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
    MultiRegionAuxiliary bool
    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.
    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
    ReservationId 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.
    SlotCapacity string
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
    concurrency String
    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.
    ignoreIdleSlots Boolean
    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
    multiRegionAuxiliary Boolean
    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.
    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
    reservationId 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.
    slotCapacity String
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
    concurrency string
    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.
    ignoreIdleSlots boolean
    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
    multiRegionAuxiliary boolean
    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.
    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
    reservationId 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.
    slotCapacity string
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
    concurrency str
    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.
    ignore_idle_slots bool
    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_auxiliary bool
    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.
    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
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
    concurrency String
    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.
    ignoreIdleSlots Boolean
    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
    multiRegionAuxiliary Boolean
    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.
    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
    reservationId 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.
    slotCapacity String
    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 ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with google.rpc.Code.RESOURCE_EXHAUSTED. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

    Outputs

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

    CreationTime string
    Creation time of the reservation.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Last update time of the reservation.
    CreationTime string
    Creation time of the reservation.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    Last update time of the reservation.
    creationTime String
    Creation time of the reservation.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Last update time of the reservation.
    creationTime string
    Creation time of the reservation.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime 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.
    creationTime String
    Creation time of the reservation.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    Last update time of the reservation.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi