1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigqueryreservation
  5. bigqueryreservation/v1
  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/v1.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

    new Reservation(name: string, args?: ReservationArgs, opts?: CustomResourceOptions);
    @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)
    @overload
    def Reservation(resource_name: str,
                    args: Optional[ReservationArgs] = None,
                    opts: Optional[ResourceOptions] = 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.
    
    
    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.

    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:

    Autoscale Pulumi.GoogleNative.BigQueryReservation.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.GoogleNative.BigQueryReservation.V1.ReservationEdition
    Edition of the reservation.
    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. 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
    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
    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 AutoscaleArgs
    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 ReservationEdition
    Edition of the reservation.
    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. 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
    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
    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 ReservationEdition
    Edition of the reservation.
    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. 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
    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
    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 ReservationEdition
    Edition of the reservation.
    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. 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
    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
    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 AutoscaleArgs
    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 ReservationEdition
    Edition of the reservation.
    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. 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.
    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. 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
    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
    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:

    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.

    Supporting Types

    Autoscale, AutoscaleArgs

    MaxSlots string
    Number of slots to be scaled when needed.
    MaxSlots string
    Number of slots to be scaled when needed.
    maxSlots String
    Number of slots to be scaled when needed.
    maxSlots string
    Number of slots to be scaled when needed.
    max_slots str
    Number of slots to be scaled when needed.
    maxSlots String
    Number of slots to be scaled when needed.

    AutoscaleResponse, AutoscaleResponseArgs

    CurrentSlots string
    The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    MaxSlots string
    Number of slots to be scaled when needed.
    CurrentSlots string
    The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    MaxSlots string
    Number of slots to be scaled when needed.
    currentSlots String
    The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots String
    Number of slots to be scaled when needed.
    currentSlots string
    The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots 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.
    currentSlots String
    The slot capacity added to this reservation when autoscale happens. Will be between [0, max_slots].
    maxSlots String
    Number of slots to be scaled when needed.

    ReservationEdition, ReservationEditionArgs

    EditionUnspecified
    EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
    Standard
    STANDARDStandard edition.
    Enterprise
    ENTERPRISEEnterprise edition.
    EnterprisePlus
    ENTERPRISE_PLUSEnterprise plus edition.
    ReservationEditionEditionUnspecified
    EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
    ReservationEditionStandard
    STANDARDStandard edition.
    ReservationEditionEnterprise
    ENTERPRISEEnterprise edition.
    ReservationEditionEnterprisePlus
    ENTERPRISE_PLUSEnterprise plus edition.
    EditionUnspecified
    EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
    Standard
    STANDARDStandard edition.
    Enterprise
    ENTERPRISEEnterprise edition.
    EnterprisePlus
    ENTERPRISE_PLUSEnterprise plus edition.
    EditionUnspecified
    EDITION_UNSPECIFIEDDefault value, which will be treated as ENTERPRISE.
    Standard
    STANDARDStandard edition.
    Enterprise
    ENTERPRISEEnterprise edition.
    EnterprisePlus
    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-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