@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
143 lines • 6.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A reservation group is a container for reservations.
*
* To get more information about ReservationGroup, see:
*
* * [API documentation](https://cloud.google.com/bigquery/docs/reference/reservations/rest/v1/projects.locations.reservationGroups)
*
* ## Example Usage
*
* ### Bigquery Reservation Group Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const reservationGroup = new gcp.bigquery.ReservationGroup("reservation_group", {
* name: "my-reservation-group",
* location: "us-west2",
* });
* ```
*
* ## Import
*
* ReservationGroup can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/reservationGroups/{{name}}`
* * `{{project}}/{{location}}/{{name}}`
* * `{{location}}/{{name}}`
*
* When using the `pulumi import` command, ReservationGroup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:bigquery/reservationGroup:ReservationGroup default projects/{{project}}/locations/{{location}}/reservationGroups/{{name}}
* $ pulumi import gcp:bigquery/reservationGroup:ReservationGroup default {{project}}/{{location}}/{{name}}
* $ pulumi import gcp:bigquery/reservationGroup:ReservationGroup default {{location}}/{{name}}
* ```
*/
export declare class ReservationGroup extends pulumi.CustomResource {
/**
* Get an existing ReservationGroup 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?: ReservationGroupState, opts?: pulumi.CustomResourceOptions): ReservationGroup;
/**
* Returns true if the given object is an instance of ReservationGroup. 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 ReservationGroup;
/**
* 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>;
/**
* The geographic location where the transfer config should reside.
* Examples: US, EU, asia-northeast1. The default value is US.
*/
readonly location: pulumi.Output<string | undefined>;
/**
* The name of the reservation group. This field must only contain alphanumeric characters or dash.
*/
readonly name: pulumi.Output<string>;
/**
* 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>;
/**
* Create a ReservationGroup 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?: ReservationGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ReservationGroup resources.
*/
export interface ReservationGroupState {
/**
* 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>;
/**
* The geographic location where the transfer config should reside.
* Examples: US, EU, asia-northeast1. The default value is US.
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the reservation group. This field must only contain alphanumeric characters or dash.
*/
name?: pulumi.Input<string | 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>;
}
/**
* The set of arguments for constructing a ReservationGroup resource.
*/
export interface ReservationGroupArgs {
/**
* 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>;
/**
* The geographic location where the transfer config should reside.
* Examples: US, EU, asia-northeast1. The default value is US.
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the reservation group. This field must only contain alphanumeric characters or dash.
*/
name?: pulumi.Input<string | 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>;
}
//# sourceMappingURL=reservationGroup.d.ts.map