UNPKG

@pulumi/pagerduty

Version:

A Pulumi package for creating and managing pagerduty cloud resources.

99 lines (98 loc) 3.52 kB
import * as pulumi from "@pulumi/pulumi"; /** * A [tag](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODEwMA-assign-tags) 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: "API"}); * const engteam = new pagerduty.Team("engteam", {name: "Engineering"}); * const exampleTagAssignment = new pagerduty.TagAssignment("example", { * tagId: example.id, * entityType: "teams", * entityId: engteam.id, * }); * ``` * * ## Import * * Tag assignments can be imported using the `id` which is constructed by taking the `entity` Type, `entity` ID and the `tag` ID separated by a dot, e.g. * * ```sh * $ pulumi import pagerduty:index/tagAssignment:TagAssignment main users.P7HHMVK.PYC7IQQ * ``` */ export declare class TagAssignment extends pulumi.CustomResource { /** * Get an existing TagAssignment 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?: TagAssignmentState, opts?: pulumi.CustomResourceOptions): TagAssignment; /** * Returns true if the given object is an instance of TagAssignment. 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 TagAssignment; /** * The ID of the entity. */ readonly entityId: pulumi.Output<string>; /** * Type of entity in the tag assignment. Possible values can be `users`, `teams`, and `escalationPolicies`. */ readonly entityType: pulumi.Output<string>; /** * The ID of the tag. */ readonly tagId: pulumi.Output<string>; /** * Create a TagAssignment 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: TagAssignmentArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering TagAssignment resources. */ export interface TagAssignmentState { /** * The ID of the entity. */ entityId?: pulumi.Input<string>; /** * Type of entity in the tag assignment. Possible values can be `users`, `teams`, and `escalationPolicies`. */ entityType?: pulumi.Input<string>; /** * The ID of the tag. */ tagId?: pulumi.Input<string>; } /** * The set of arguments for constructing a TagAssignment resource. */ export interface TagAssignmentArgs { /** * The ID of the entity. */ entityId: pulumi.Input<string>; /** * Type of entity in the tag assignment. Possible values can be `users`, `teams`, and `escalationPolicies`. */ entityType: pulumi.Input<string>; /** * The ID of the tag. */ tagId: pulumi.Input<string>; }