LiteTopic 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 gcp.pubsub.Topic instead.

A named resource to which messages are sent by publishers.

To get more information about Topic, see:

• API documentation
• How-to Guides
• Managing Topics

Example Usage

Pubsub Lite Topic 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,
});
const exampleLiteTopic = new gcp.pubsub.LiteTopic("example", {
    name: "example-topic",
    project: project.then(project => project.number),
    partitionConfig: {
        count: 1,
        capacity: {
            publishMibPerSec: 4,
            subscribeMibPerSec: 8,
        },
    },
    retentionConfig: {
        perPartitionBytes: "32212254720",
    },
    reservationConfig: {
        throughputReservation: example.name,
    },
});

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)
example_lite_topic = gcp.pubsub.LiteTopic("example",
    name="example-topic",
    project=project.number,
    partition_config={
        "count": 1,
        "capacity": {
            "publish_mib_per_sec": 4,
            "subscribe_mib_per_sec": 8,
        },
    },
    retention_config={
        "per_partition_bytes": "32212254720",
    },
    reservation_config={
        "throughput_reservation": example.name,
    })

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,
    });

    var exampleLiteTopic = new Gcp.PubSub.LiteTopic("example", new()
    {
        Name = "example-topic",
        Project = project.Apply(getProjectResult => getProjectResult.Number),
        PartitionConfig = new Gcp.PubSub.Inputs.LiteTopicPartitionConfigArgs
        {
            Count = 1,
            Capacity = new Gcp.PubSub.Inputs.LiteTopicPartitionConfigCapacityArgs
            {
                PublishMibPerSec = 4,
                SubscribeMibPerSec = 8,
            },
        },
        RetentionConfig = new Gcp.PubSub.Inputs.LiteTopicRetentionConfigArgs
        {
            PerPartitionBytes = "32212254720",
        },
        ReservationConfig = new Gcp.PubSub.Inputs.LiteTopicReservationConfigArgs
        {
            ThroughputReservation = example.Name,
        },
    });

});

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
		}
		example, 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
		}
		_, err = pubsub.NewLiteTopic(ctx, "example", &pubsub.LiteTopicArgs{
			Name:    pulumi.String("example-topic"),
			Project: pulumi.String(project.Number),
			PartitionConfig: &pubsub.LiteTopicPartitionConfigArgs{
				Count: pulumi.Int(1),
				Capacity: &pubsub.LiteTopicPartitionConfigCapacityArgs{
					PublishMibPerSec:   pulumi.Int(4),
					SubscribeMibPerSec: pulumi.Int(8),
				},
			},
			RetentionConfig: &pubsub.LiteTopicRetentionConfigArgs{
				PerPartitionBytes: pulumi.String("32212254720"),
			},
			ReservationConfig: &pubsub.LiteTopicReservationConfigArgs{
				ThroughputReservation: example.Name,
			},
		})
		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
}
resource "gcp_pubsub_litetopic" "example" {
  name    = "example-topic"
  project = data.gcp_organizations_getproject.project.number
  partition_config = {
    count = 1
    capacity = {
      publish_mib_per_sec   = 4
      subscribe_mib_per_sec = 8
    }
  }
  retention_config = {
    per_partition_bytes = 32212254720
  }
  reservation_config = {
    throughput_reservation = gcp_pubsub_litereservation.example.name
  }
}

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 com.pulumi.gcp.pubsub.LiteTopic;
import com.pulumi.gcp.pubsub.LiteTopicArgs;
import com.pulumi.gcp.pubsub.inputs.LiteTopicPartitionConfigArgs;
import com.pulumi.gcp.pubsub.inputs.LiteTopicPartitionConfigCapacityArgs;
import com.pulumi.gcp.pubsub.inputs.LiteTopicRetentionConfigArgs;
import com.pulumi.gcp.pubsub.inputs.LiteTopicReservationConfigArgs;
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());

        var exampleLiteTopic = new LiteTopic("exampleLiteTopic", LiteTopicArgs.builder()
            .name("example-topic")
            .project(project.number())
            .partitionConfig(LiteTopicPartitionConfigArgs.builder()
                .count(1)
                .capacity(LiteTopicPartitionConfigCapacityArgs.builder()
                    .publishMibPerSec(4)
                    .subscribeMibPerSec(8)
                    .build())
                .build())
            .retentionConfig(LiteTopicRetentionConfigArgs.builder()
                .perPartitionBytes("32212254720")
                .build())
            .reservationConfig(LiteTopicReservationConfigArgs.builder()
                .throughputReservation(example.name())
                .build())
            .build());

    }
}

resources:
  example:
    type: gcp:pubsub:LiteReservation
    properties:
      name: example-reservation
      project: ${project.number}
      throughputCapacity: 2
  exampleLiteTopic:
    type: gcp:pubsub:LiteTopic
    name: example
    properties:
      name: example-topic
      project: ${project.number}
      partitionConfig:
        count: 1
        capacity:
          publishMibPerSec: 4
          subscribeMibPerSec: 8
      retentionConfig:
        perPartitionBytes: 3.221225472e+10
      reservationConfig:
        throughputReservation: ${example.name}
variables:
  project:
    fn::invoke:
      function: gcp:organizations:getProject
      arguments: {}

Import

Topic can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{zone}}/topics/{{name}}
• {{project}}/{{zone}}/{{name}}
• {{zone}}/{{name}}
• {{name}}

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

$ pulumi import gcp:pubsub/liteTopic:LiteTopic default projects/{{project}}/locations/{{zone}}/topics/{{name}}
$ pulumi import gcp:pubsub/liteTopic:LiteTopic default {{project}}/{{zone}}/{{name}}
$ pulumi import gcp:pubsub/liteTopic:LiteTopic default {{zone}}/{{name}}
$ pulumi import gcp:pubsub/liteTopic:LiteTopic default {{name}}

Constructors

LiteTopic(String name, {LiteTopicArgs? args, CustomResourceOptions? options})

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

LiteTopic.reference(String urn)

Creates a typed reference to an existing LiteTopic 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 topic.

late, final

partitionConfig ↔ Output<LiteTopicPartitionConfig?>

The settings for this topic's partitions. Structure is documented below.

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 topic.

late, final

reservationConfig ↔ Output<LiteTopicReservationConfig?>

The settings for this topic's Reservation usage. Structure is documented below.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

retentionConfig ↔ Output<LiteTopicRetentionConfig?>

The settings for a topic's message retention. Structure is documented below.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

zone ↔ Output<String?>

The zone of the pubsub lite topic.

late, final

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

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