@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
192 lines • 8.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The BigqueryReservation Assignment resource.
*
* To get more information about ReservationAssignment, see:
*
* * [API documentation](https://cloud.google.com/bigquery/docs/reference/reservations/rest/v1/projects.locations.reservations.assignments)
* * How-to Guides
* * [Work with reservation assignments](https://cloud.google.com/bigquery/docs/reservations-assignments)
*
* ## Example Usage
*
* ### Bigquery Reservation Assignment Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const basic = new gcp.bigquery.Reservation("basic", {
* name: "example-reservation",
* project: "my-project-name",
* location: "us-central1",
* slotCapacity: 0,
* ignoreIdleSlots: false,
* });
* const assignment = new gcp.bigquery.ReservationAssignment("assignment", {
* assignee: "projects/my-project-name",
* jobType: "PIPELINE",
* reservation: basic.id,
* });
* ```
*
* ## Import
*
* ReservationAssignment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/reservations/{{reservation}}/assignments/{{name}}`
* * `{{project}}/{{location}}/{{reservation}}/{{name}}`
* * `{{location}}/{{reservation}}/{{name}}`
*
* When using the `pulumi import` command, ReservationAssignment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:bigquery/reservationAssignment:ReservationAssignment default projects/{{project}}/locations/{{location}}/reservations/{{reservation}}/assignments/{{name}}
* $ pulumi import gcp:bigquery/reservationAssignment:ReservationAssignment default {{project}}/{{location}}/{{reservation}}/{{name}}
* $ pulumi import gcp:bigquery/reservationAssignment:ReservationAssignment default {{location}}/{{reservation}}/{{name}}
* ```
*/
export declare class ReservationAssignment extends pulumi.CustomResource {
/**
* Get an existing ReservationAssignment 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?: ReservationAssignmentState, opts?: pulumi.CustomResourceOptions): ReservationAssignment;
/**
* Returns true if the given object is an instance of ReservationAssignment. 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 ReservationAssignment;
/**
* The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
*/
readonly assignee: pulumi.Output<string>;
/**
* 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>;
/**
* Types of job, which could be specified when using the reservation. Possible values: JOB_TYPE_UNSPECIFIED, PIPELINE, QUERY, CONTINUOUS
*/
readonly jobType: pulumi.Output<string>;
/**
* The location for the resource
*/
readonly location: pulumi.Output<string>;
/**
* Output only. The resource name of the assignment.
*/
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>;
/**
* The reservation for the resource
*/
readonly reservation: pulumi.Output<string>;
/**
* Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.
* Possible values: STATE_UNSPECIFIED, PENDING, ACTIVE
*/
readonly state: pulumi.Output<string>;
/**
* Create a ReservationAssignment 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: ReservationAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ReservationAssignment resources.
*/
export interface ReservationAssignmentState {
/**
* The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
*/
assignee?: pulumi.Input<string | undefined>;
/**
* 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>;
/**
* Types of job, which could be specified when using the reservation. Possible values: JOB_TYPE_UNSPECIFIED, PIPELINE, QUERY, CONTINUOUS
*/
jobType?: pulumi.Input<string | undefined>;
/**
* The location for the resource
*/
location?: pulumi.Input<string | undefined>;
/**
* Output only. The resource name of the assignment.
*/
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 reservation for the resource
*/
reservation?: pulumi.Input<string | undefined>;
/**
* Assignment will remain in PENDING state if no active capacity commitment is present. It will become ACTIVE when some capacity commitment becomes active.
* Possible values: STATE_UNSPECIFIED, PENDING, ACTIVE
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ReservationAssignment resource.
*/
export interface ReservationAssignmentArgs {
/**
* The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.
*/
assignee: pulumi.Input<string>;
/**
* 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>;
/**
* Types of job, which could be specified when using the reservation. Possible values: JOB_TYPE_UNSPECIFIED, PIPELINE, QUERY, CONTINUOUS
*/
jobType: pulumi.Input<string>;
/**
* The location for the resource
*/
location?: 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 reservation for the resource
*/
reservation: pulumi.Input<string>;
}
//# sourceMappingURL=reservationAssignment.d.ts.map