ReservationAssignment class

The BigqueryReservation Assignment resource.

To get more information about ReservationAssignment, see:

• API documentation
• How-to Guides
• Work with reservation assignments

Example Usage

Bigquery Reservation Assignment Basic

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 pulumi
import pulumi_gcp as gcp

basic = gcp.bigquery.Reservation("basic",
    name="example-reservation",
    project="my-project-name",
    location="us-central1",
    slot_capacity=0,
    ignore_idle_slots=False)
assignment = gcp.bigquery.ReservationAssignment("assignment",
    assignee="projects/my-project-name",
    job_type="PIPELINE",
    reservation=basic.id)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.BigQuery.Reservation("basic", new()
    {
        Name = "example-reservation",
        Project = "my-project-name",
        Location = "us-central1",
        SlotCapacity = 0,
        IgnoreIdleSlots = false,
    });

    var assignment = new Gcp.BigQuery.ReservationAssignment("assignment", new()
    {
        Assignee = "projects/my-project-name",
        JobType = "PIPELINE",
        Reservation = basic.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/bigquery"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		basic, err := bigquery.NewReservation(ctx, "basic", &bigquery.ReservationArgs{
			Name:            pulumi.String("example-reservation"),
			Project:         pulumi.String("my-project-name"),
			Location:        pulumi.String("us-central1"),
			SlotCapacity:    pulumi.Int(0),
			IgnoreIdleSlots: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		_, err = bigquery.NewReservationAssignment(ctx, "assignment", &bigquery.ReservationAssignmentArgs{
			Assignee:    pulumi.String("projects/my-project-name"),
			JobType:     pulumi.String("PIPELINE"),
			Reservation: basic.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_bigquery_reservation" "basic" {
  name              = "example-reservation"
  project           = "my-project-name"
  location          = "us-central1"
  slot_capacity     = 0
  ignore_idle_slots = false
}
resource "gcp_bigquery_reservationassignment" "assignment" {
  assignee    = "projects/my-project-name"
  job_type    = "PIPELINE"
  reservation = gcp_bigquery_reservation.basic.id
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigquery.Reservation;
import com.pulumi.gcp.bigquery.ReservationArgs;
import com.pulumi.gcp.bigquery.ReservationAssignment;
import com.pulumi.gcp.bigquery.ReservationAssignmentArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 basic = new Reservation("basic", ReservationArgs.builder()
            .name("example-reservation")
            .project("my-project-name")
            .location("us-central1")
            .slotCapacity(0)
            .ignoreIdleSlots(false)
            .build());

        var assignment = new ReservationAssignment("assignment", ReservationAssignmentArgs.builder()
            .assignee("projects/my-project-name")
            .jobType("PIPELINE")
            .reservation(basic.id())
            .build());

    }
}

resources:
  basic:
    type: gcp:bigquery:Reservation
    properties:
      name: example-reservation
      project: my-project-name
      location: us-central1
      slotCapacity: 0
      ignoreIdleSlots: false
  assignment:
    type: gcp:bigquery:ReservationAssignment
    properties:
      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:

$ 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}}

Constructors

ReservationAssignment(String name, {ReservationAssignmentArgs? args, CustomResourceOptions? options})

Creates a new ReservationAssignment. name The Pulumi resource name. args Arguments used to configure this ReservationAssignment. The set of arguments for ReservationAssignment. options Resource options controlling this resource's behavior.

ReservationAssignment.reference(String urn)

Creates a typed reference to an existing ReservationAssignment resource.

Properties

assignee ↔ Output<String>

The resource which will use the reservation. E.g. projects/myproject, folders/123, organizations/456.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ 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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

jobType ↔ Output<String>

Types of job, which could be specified when using the reservation. Possible values: JOB_TYPE_UNSPECIFIED, PIPELINE, QUERY, CONTINUOUS

late, final

location ↔ Output<String>

The location for the resource

late, final

name ↔ Output<String>

Output only. The resource name of the assignment.

late, final

principal ↔ Output<String?>

Optional. Represents the principal for this assignment. If not empty, jobs run by this principal will utilize the associated reservation. Otherwise, jobs will fall back to using the reservation assigned to the project, folder, or organization (in that order). If no reservation is assigned at any of these levels, on-demand capacity will be used. The supported formats are:

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

reservation ↔ Output<String>

The reservation for the resource

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

state ↔ 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

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ReservationAssignmentState? state, CustomResourceOptions? options}) → ReservationAssignment

Gets an existing ReservationAssignment resource's state with the given name and id.