getSubscription function

Future<GetSubscriptionResult> getSubscription(
  1. GetSubscriptionArgs args, {
  2. InvokeOptions? options,
})

Get information about a Google Cloud Pub/Sub Subscription. For more information see the official documentation and API.

Example Usage

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

const my_pubsub_subscription = gcp.pubsub.getSubscription({
    name: "my-pubsub-subscription",
});
import pulumi
import pulumi_gcp as gcp

my_pubsub_subscription = gcp.pubsub.get_subscription(name="my-pubsub-subscription")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var my_pubsub_subscription = Gcp.PubSub.GetSubscription.Invoke(new()
    {
        Name = "my-pubsub-subscription",
    });

});
package main

import (
	"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 {
		_, err := pubsub.LookupSubscription(ctx, &pubsub.LookupSubscriptionArgs{
			Name: "my-pubsub-subscription",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

data "gcp_pubsub_getsubscription" "my-pubsub-subscription" {
  name = "my-pubsub-subscription"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.pubsub.PubsubFunctions;
import com.pulumi.gcp.pubsub.inputs.GetSubscriptionArgs;
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 my-pubsub-subscription = PubsubFunctions.getSubscription(GetSubscriptionArgs.builder()
            .name("my-pubsub-subscription")
            .build());

    }
}
variables:
  my-pubsub-subscription:
    fn::invoke:
      function: gcp:pubsub:getSubscription
      arguments:
        name: my-pubsub-subscription

args Arguments passed to this invoke. Arguments for getSubscription. options Invoke options controlling this call.

Implementation

Future<GetSubscriptionResult> getSubscription(
  GetSubscriptionArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'gcp:pubsub/getSubscription:getSubscription',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetSubscriptionResult.fromMap(result);
}