@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
198 lines (197 loc) • 6.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A named resource representing the stream of messages from a single,
* specific topic, to be delivered to the subscribing application.
*
* To get more information about Subscription, see:
*
* * [API documentation](https://cloud.google.com/pubsub/lite/docs/reference/rest/v1/admin.projects.locations.subscriptions)
* * How-to Guides
* * [Managing Subscriptions](https://cloud.google.com/pubsub/lite/docs/subscriptions)
*
* ## Example Usage
*
* ### Pubsub Lite Subscription Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const example = 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",
* },
* });
* const exampleLiteSubscription = new gcp.pubsub.LiteSubscription("example", {
* name: "example-subscription",
* topic: example.name,
* deliveryConfig: {
* deliveryRequirement: "DELIVER_AFTER_STORED",
* },
* });
* ```
*
* ## Import
*
* Subscription can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{zone}}/subscriptions/{{name}}`
*
* * `{{project}}/{{zone}}/{{name}}`
*
* * `{{zone}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, Subscription can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:pubsub/liteSubscription:LiteSubscription default projects/{{project}}/locations/{{zone}}/subscriptions/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:pubsub/liteSubscription:LiteSubscription default {{project}}/{{zone}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:pubsub/liteSubscription:LiteSubscription default {{zone}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:pubsub/liteSubscription:LiteSubscription default {{name}}
* ```
*/
export declare class LiteSubscription extends pulumi.CustomResource {
/**
* Get an existing LiteSubscription 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?: LiteSubscriptionState, opts?: pulumi.CustomResourceOptions): LiteSubscription;
/**
* Returns true if the given object is an instance of LiteSubscription. 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 LiteSubscription;
/**
* The settings for this subscription's message delivery.
* Structure is documented below.
*/
readonly deliveryConfig: pulumi.Output<outputs.pubsub.LiteSubscriptionDeliveryConfig | undefined>;
/**
* Name of the subscription.
*
*
* - - -
*/
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 region of the pubsub lite topic.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* A reference to a Topic resource.
*/
readonly topic: pulumi.Output<string>;
/**
* The zone of the pubsub lite topic.
*/
readonly zone: pulumi.Output<string | undefined>;
/**
* Create a LiteSubscription 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: LiteSubscriptionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LiteSubscription resources.
*/
export interface LiteSubscriptionState {
/**
* The settings for this subscription's message delivery.
* Structure is documented below.
*/
deliveryConfig?: pulumi.Input<inputs.pubsub.LiteSubscriptionDeliveryConfig>;
/**
* Name of the subscription.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region of the pubsub lite topic.
*/
region?: pulumi.Input<string>;
/**
* A reference to a Topic resource.
*/
topic?: pulumi.Input<string>;
/**
* The zone of the pubsub lite topic.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a LiteSubscription resource.
*/
export interface LiteSubscriptionArgs {
/**
* The settings for this subscription's message delivery.
* Structure is documented below.
*/
deliveryConfig?: pulumi.Input<inputs.pubsub.LiteSubscriptionDeliveryConfig>;
/**
* Name of the subscription.
*
*
* - - -
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The region of the pubsub lite topic.
*/
region?: pulumi.Input<string>;
/**
* A reference to a Topic resource.
*/
topic: pulumi.Input<string>;
/**
* The zone of the pubsub lite topic.
*/
zone?: pulumi.Input<string>;
}