UNPKG

@pulumi/pagerduty

Version:

A Pulumi package for creating and managing pagerduty cloud resources.

85 lines (84 loc) 3.15 kB
import * as pulumi from "@pulumi/pulumi"; /** * A [tag](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIxOA-create-a-tag) is applied to Escalation Policies, Teams or Users and can be used to filter them. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as pagerduty from "@pulumi/pagerduty"; * * const example = new pagerduty.Tag("example", {label: "Product"}); * ``` * * ## Import * * Tags can be imported using the `id`, e.g. * * ```sh * $ pulumi import pagerduty:index/tag:Tag main PLBP09X * ``` */ export declare class Tag extends pulumi.CustomResource { /** * Get an existing Tag 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?: TagState, opts?: pulumi.CustomResourceOptions): Tag; /** * Returns true if the given object is an instance of Tag. 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 Tag; /** * URL at which the entity is uniquely displayed in the Web app. */ readonly htmlUrl: pulumi.Output<string>; /** * The label of the tag. */ readonly label: pulumi.Output<string>; /** * A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier. */ readonly summary: pulumi.Output<string>; /** * Create a Tag 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: TagArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Tag resources. */ export interface TagState { /** * URL at which the entity is uniquely displayed in the Web app. */ htmlUrl?: pulumi.Input<string>; /** * The label of the tag. */ label?: pulumi.Input<string>; /** * A short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier. */ summary?: pulumi.Input<string>; } /** * The set of arguments for constructing a Tag resource. */ export interface TagArgs { /** * The label of the tag. */ label: pulumi.Input<string>; }