@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
177 lines • 7.43 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Represents a BI Reservation.
*
* To get more information about BiReservation, see:
*
* * [API documentation](https://cloud.google.com/bigquery/docs/reference/reservations/rest/v1/BiReservation)
* * How-to Guides
* * [Introduction to Reservations](https://cloud.google.com/bigquery/docs/reservations-intro)
*
* ## Example Usage
*
* ### Bigquery Reservation Bi Reservation Basic
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ 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}}
* ```
*/
export declare class BiReservation extends pulumi.CustomResource {
/**
* Get an existing BiReservation resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BiReservationState, opts?: pulumi.CustomResourceOptions): BiReservation;
/**
* Returns true if the given object is an instance of BiReservation. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is BiReservation;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* LOCATION_DESCRIPTION
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the singleton BI reservation. Reservation names have the form `projects/{projectId}/locations/{locationId}/biReservation`.
*/
readonly name: pulumi.Output<string>;
/**
* Preferred tables to use BI capacity for.
* Structure is documented below.
*/
readonly preferredTables: pulumi.Output<outputs.bigquery.BiReservationPreferredTable[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* Size of a reservation, in bytes.
*/
readonly size: pulumi.Output<number | undefined>;
/**
* 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".
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a BiReservation resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: BiReservationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering BiReservation resources.
*/
export interface BiReservationState {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* LOCATION_DESCRIPTION
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the singleton BI reservation. Reservation names have the form `projects/{projectId}/locations/{locationId}/biReservation`.
*/
name?: pulumi.Input<string | undefined>;
/**
* Preferred tables to use BI capacity for.
* Structure is documented below.
*/
preferredTables?: pulumi.Input<pulumi.Input<inputs.bigquery.BiReservationPreferredTable>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Size of a reservation, in bytes.
*/
size?: pulumi.Input<number | undefined>;
/**
* 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".
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a BiReservation resource.
*/
export interface BiReservationArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* LOCATION_DESCRIPTION
*/
location: pulumi.Input<string>;
/**
* Preferred tables to use BI capacity for.
* Structure is documented below.
*/
preferredTables?: pulumi.Input<pulumi.Input<inputs.bigquery.BiReservationPreferredTable>[] | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Size of a reservation, in bytes.
*/
size?: pulumi.Input<number | undefined>;
}
//# sourceMappingURL=biReservation.d.ts.map