1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigquery
  5. BiReservation
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

gcp.bigquery.BiReservation

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi

    Represents a BI Reservation.

    To get more information about BiReservation, see:

    Example Usage

    Bigquery Reservation Bi Reservation Basic

    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const reservation = new gcp.bigquery.BiReservation("reservation", {
        location: "us-west2",
        size: 3000000000,
    });
    
    import pulumi
    import pulumi_gcp as gcp
    
    reservation = gcp.bigquery.BiReservation("reservation",
        location="us-west2",
        size=3000000000)
    
    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.NewBiReservation(ctx, "reservation", &bigquery.BiReservationArgs{
    			Location: pulumi.String("us-west2"),
    			Size:     pulumi.Int(3000000000),
    		})
    		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.BiReservation("reservation", new()
        {
            Location = "us-west2",
            Size = 3000000000,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.gcp.bigquery.BiReservation;
    import com.pulumi.gcp.bigquery.BiReservationArgs;
    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 BiReservation("reservation", BiReservationArgs.builder()
                .location("us-west2")
                .size("3000000000")
                .build());
    
        }
    }
    
    resources:
      reservation:
        type: gcp:bigquery:BiReservation
        properties:
          location: us-west2
          size: '3000000000'
    

    Create BiReservation Resource

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

    Constructor syntax

    new BiReservation(name: string, args: BiReservationArgs, opts?: CustomResourceOptions);
    @overload
    def BiReservation(resource_name: str,
                      args: BiReservationArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def BiReservation(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      preferred_tables: Optional[Sequence[BiReservationPreferredTableArgs]] = None,
                      project: Optional[str] = None,
                      size: Optional[int] = None)
    func NewBiReservation(ctx *Context, name string, args BiReservationArgs, opts ...ResourceOption) (*BiReservation, error)
    public BiReservation(string name, BiReservationArgs args, CustomResourceOptions? opts = null)
    public BiReservation(String name, BiReservationArgs args)
    public BiReservation(String name, BiReservationArgs args, CustomResourceOptions options)
    
    type: gcp:bigquery:BiReservation
    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 BiReservationArgs
    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 BiReservationArgs
    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 BiReservationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BiReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BiReservationArgs
    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 biReservationResource = new Gcp.BigQuery.BiReservation("biReservationResource", new()
    {
        Location = "string",
        PreferredTables = new[]
        {
            new Gcp.BigQuery.Inputs.BiReservationPreferredTableArgs
            {
                DatasetId = "string",
                ProjectId = "string",
                TableId = "string",
            },
        },
        Project = "string",
        Size = 0,
    });
    
    example, err := bigquery.NewBiReservation(ctx, "biReservationResource", &bigquery.BiReservationArgs{
    	Location: pulumi.String("string"),
    	PreferredTables: bigquery.BiReservationPreferredTableArray{
    		&bigquery.BiReservationPreferredTableArgs{
    			DatasetId: pulumi.String("string"),
    			ProjectId: pulumi.String("string"),
    			TableId:   pulumi.String("string"),
    		},
    	},
    	Project: pulumi.String("string"),
    	Size:    pulumi.Int(0),
    })
    
    var biReservationResource = new BiReservation("biReservationResource", BiReservationArgs.builder()
        .location("string")
        .preferredTables(BiReservationPreferredTableArgs.builder()
            .datasetId("string")
            .projectId("string")
            .tableId("string")
            .build())
        .project("string")
        .size(0)
        .build());
    
    bi_reservation_resource = gcp.bigquery.BiReservation("biReservationResource",
        location="string",
        preferred_tables=[{
            "datasetId": "string",
            "projectId": "string",
            "tableId": "string",
        }],
        project="string",
        size=0)
    
    const biReservationResource = new gcp.bigquery.BiReservation("biReservationResource", {
        location: "string",
        preferredTables: [{
            datasetId: "string",
            projectId: "string",
            tableId: "string",
        }],
        project: "string",
        size: 0,
    });
    
    type: gcp:bigquery:BiReservation
    properties:
        location: string
        preferredTables:
            - datasetId: string
              projectId: string
              tableId: string
        project: string
        size: 0
    

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

    Location string
    LOCATION_DESCRIPTION


    PreferredTables List<BiReservationPreferredTable>
    Preferred tables to use BI capacity for. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Size int
    Size of a reservation, in bytes.
    Location string
    LOCATION_DESCRIPTION


    PreferredTables []BiReservationPreferredTableArgs
    Preferred tables to use BI capacity for. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Size int
    Size of a reservation, in bytes.
    location String
    LOCATION_DESCRIPTION


    preferredTables List<BiReservationPreferredTable>
    Preferred tables to use BI capacity for. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size Integer
    Size of a reservation, in bytes.
    location string
    LOCATION_DESCRIPTION


    preferredTables BiReservationPreferredTable[]
    Preferred tables to use BI capacity for. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size number
    Size of a reservation, in bytes.
    location str
    LOCATION_DESCRIPTION


    preferred_tables Sequence[BiReservationPreferredTableArgs]
    Preferred tables to use BI capacity for. Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size int
    Size of a reservation, in bytes.
    location String
    LOCATION_DESCRIPTION


    preferredTables List<Property Map>
    Preferred tables to use BI capacity for. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size Number
    Size of a reservation, in bytes.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    UpdateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    UpdateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    updateTime String
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    updateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    update_time str
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    updateTime String
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

    Look up Existing BiReservation Resource

    Get an existing BiReservation 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?: BiReservationState, opts?: CustomResourceOptions): BiReservation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            preferred_tables: Optional[Sequence[BiReservationPreferredTableArgs]] = None,
            project: Optional[str] = None,
            size: Optional[int] = None,
            update_time: Optional[str] = None) -> BiReservation
    func GetBiReservation(ctx *Context, name string, id IDInput, state *BiReservationState, opts ...ResourceOption) (*BiReservation, error)
    public static BiReservation Get(string name, Input<string> id, BiReservationState? state, CustomResourceOptions? opts = null)
    public static BiReservation get(String name, Output<String> id, BiReservationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    Location string
    LOCATION_DESCRIPTION


    Name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    PreferredTables List<BiReservationPreferredTable>
    Preferred tables to use BI capacity for. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Size int
    Size of a reservation, in bytes.
    UpdateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    Location string
    LOCATION_DESCRIPTION


    Name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    PreferredTables []BiReservationPreferredTableArgs
    Preferred tables to use BI capacity for. Structure is documented below.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Size int
    Size of a reservation, in bytes.
    UpdateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    location String
    LOCATION_DESCRIPTION


    name String
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    preferredTables List<BiReservationPreferredTable>
    Preferred tables to use BI capacity for. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size Integer
    Size of a reservation, in bytes.
    updateTime String
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    location string
    LOCATION_DESCRIPTION


    name string
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    preferredTables BiReservationPreferredTable[]
    Preferred tables to use BI capacity for. Structure is documented below.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size number
    Size of a reservation, in bytes.
    updateTime string
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    location str
    LOCATION_DESCRIPTION


    name str
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    preferred_tables Sequence[BiReservationPreferredTableArgs]
    Preferred tables to use BI capacity for. Structure is documented below.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size int
    Size of a reservation, in bytes.
    update_time str
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
    location String
    LOCATION_DESCRIPTION


    name String
    The resource name of the singleton BI reservation. Reservation names have the form projects/{projectId}/locations/{locationId}/biReservation.
    preferredTables List<Property Map>
    Preferred tables to use BI capacity for. Structure is documented below.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    size Number
    Size of a reservation, in bytes.
    updateTime String
    The last update timestamp of a reservation. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

    Supporting Types

    BiReservationPreferredTable, BiReservationPreferredTableArgs

    DatasetId string
    The ID of the dataset in the above project.
    ProjectId string
    The assigned project ID of the project.
    TableId string
    The ID of the table in the above dataset.
    DatasetId string
    The ID of the dataset in the above project.
    ProjectId string
    The assigned project ID of the project.
    TableId string
    The ID of the table in the above dataset.
    datasetId String
    The ID of the dataset in the above project.
    projectId String
    The assigned project ID of the project.
    tableId String
    The ID of the table in the above dataset.
    datasetId string
    The ID of the dataset in the above project.
    projectId string
    The assigned project ID of the project.
    tableId string
    The ID of the table in the above dataset.
    dataset_id str
    The ID of the dataset in the above project.
    project_id str
    The assigned project ID of the project.
    table_id str
    The ID of the table in the above dataset.
    datasetId String
    The ID of the dataset in the above project.
    projectId String
    The assigned project ID of the project.
    tableId String
    The ID of the table in the above dataset.

    Import

    BiReservation can be imported using any of these accepted formats:

    • projects/{{project}}/locations/{{location}}/biReservation

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

    • {{location}}

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

    $ pulumi import gcp:bigquery/biReservation:BiReservation default projects/{{project}}/locations/{{location}}/biReservation
    
    $ pulumi import gcp:bigquery/biReservation:BiReservation default {{project}}/{{location}}
    
    $ pulumi import gcp:bigquery/biReservation:BiReservation default {{location}}
    

    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 Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi