@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
103 lines (102 loc) • 3.37 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get information about a Google Cloud Pub/Sub Subscription. For more information see
* the [official documentation](https://cloud.google.com/pubsub/docs/)
* and [API](https://cloud.google.com/pubsub/docs/apis).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_pubsub_subscription = gcp.pubsub.getSubscription({
* name: "my-pubsub-subscription",
* });
* ```
*/
export declare function getSubscription(args: GetSubscriptionArgs, opts?: pulumi.InvokeOptions): Promise<GetSubscriptionResult>;
/**
* A collection of arguments for invoking getSubscription.
*/
export interface GetSubscriptionArgs {
/**
* The name of the Cloud Pub/Sub Subscription.
*
* - - -
*/
name: string;
/**
* The project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: string;
}
/**
* A collection of values returned by getSubscription.
*/
export interface GetSubscriptionResult {
readonly ackDeadlineSeconds: number;
readonly bigqueryConfigs: outputs.pubsub.GetSubscriptionBigqueryConfig[];
readonly cloudStorageConfigs: outputs.pubsub.GetSubscriptionCloudStorageConfig[];
readonly deadLetterPolicies: outputs.pubsub.GetSubscriptionDeadLetterPolicy[];
readonly effectiveLabels: {
[key: string]: string;
};
readonly enableExactlyOnceDelivery: boolean;
readonly enableMessageOrdering: boolean;
readonly expirationPolicies: outputs.pubsub.GetSubscriptionExpirationPolicy[];
readonly filter: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly labels: {
[key: string]: string;
};
readonly messageRetentionDuration: string;
readonly messageTransforms: outputs.pubsub.GetSubscriptionMessageTransform[];
readonly name: string;
readonly project?: string;
readonly pulumiLabels: {
[key: string]: string;
};
readonly pushConfigs: outputs.pubsub.GetSubscriptionPushConfig[];
readonly retainAckedMessages: boolean;
readonly retryPolicies: outputs.pubsub.GetSubscriptionRetryPolicy[];
readonly topic: string;
}
/**
* Get information about a Google Cloud Pub/Sub Subscription. For more information see
* the [official documentation](https://cloud.google.com/pubsub/docs/)
* and [API](https://cloud.google.com/pubsub/docs/apis).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_pubsub_subscription = gcp.pubsub.getSubscription({
* name: "my-pubsub-subscription",
* });
* ```
*/
export declare function getSubscriptionOutput(args: GetSubscriptionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSubscriptionResult>;
/**
* A collection of arguments for invoking getSubscription.
*/
export interface GetSubscriptionOutputArgs {
/**
* The name of the Cloud Pub/Sub Subscription.
*
* - - -
*/
name: pulumi.Input<string>;
/**
* The project in which the resource belongs. If it
* is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
}