LiteReservation class

> Warning: Pubsub Lite is deprecated and will be turned down effective March 18, 2026. The resource will be removed in a future major release, please use googlePubsubReservation instead.

A named resource representing a shared pool of capacity.

To get more information about Reservation, see:

• API documentation
• How-to Guides
• Managing Reservations

Example Usage

Pubsub Lite Reservation Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const project = gcp.organizations.getProject({});
const example = new gcp.pubsub.LiteReservation("example", {
    name: "example-reservation",
    project: project.then(project => project.number),
    throughputCapacity: 2,
});

import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
example = gcp.pubsub.LiteReservation("example",
    name="example-reservation",
    project=project.number,
    throughput_capacity=2)

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

return await Deployment.RunAsync(() =>
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var example = new Gcp.PubSub.LiteReservation("example", new()
    {
        Name = "example-reservation",
        Project = project.Apply(getProjectResult => getProjectResult.Number),
        ThroughputCapacity = 2,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.LookupProject(ctx, &organizations.LookupProjectArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = pubsub.NewLiteReservation(ctx, "example", &pubsub.LiteReservationArgs{
			Name:               pulumi.String("example-reservation"),
			Project:            pulumi.String(project.Number),
			ThroughputCapacity: pulumi.Int(2),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

data "gcp_organizations_getproject" "project" {
}

resource "gcp_pubsub_litereservation" "example" {
  name                = "example-reservation"
  project             = data.gcp_organizations_getproject.project.number
  throughput_capacity = 2
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.pubsub.LiteReservation;
import com.pulumi.gcp.pubsub.LiteReservationArgs;
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) {
        final var project = OrganizationsFunctions.getProject(GetProjectArgs.builder()
            .build());

        var example = new LiteReservation("example", LiteReservationArgs.builder()
            .name("example-reservation")
            .project(project.number())
            .throughputCapacity(2)
            .build());

    }
}

resources:
  example:
    type: gcp:pubsub:LiteReservation
    properties:
      name: example-reservation
      project: ${project.number}
      throughputCapacity: 2
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}

Import

Reservation can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{region}}/reservations/{{name}}
• {{project}}/{{region}}/{{name}}
• {{region}}/{{name}}
• {{name}}

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

$ pulumi import gcp:pubsub/liteReservation:LiteReservation default projects/{{project}}/locations/{{region}}/reservations/{{name}}
$ pulumi import gcp:pubsub/liteReservation:LiteReservation default {{project}}/{{region}}/{{name}}
$ pulumi import gcp:pubsub/liteReservation:LiteReservation default {{region}}/{{name}}
$ pulumi import gcp:pubsub/liteReservation:LiteReservation default {{name}}

Constructors

LiteReservation(String name, {LiteReservationArgs? args, CustomResourceOptions? options})

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

LiteReservation.reference(String urn)

Creates a typed reference to an existing LiteReservation resource.

Properties

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

name ↔ Output<String>

Name of the reservation.

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

region ↔ Output<String?>

The region of the pubsub lite reservation.

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

throughputCapacity ↔ Output<int>

The reserved throughput capacity. Every unit of throughput capacity is equivalent to 1 MiB/s of published messages or 2 MiB/s of subscribed messages.

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, {LiteReservationState? state, CustomResourceOptions? options}) → LiteReservation

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