@pulumi/pagerduty/businessServiceSubscriber.d.ts

A Pulumi package for creating and managing pagerduty cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * A [business service subscriber](https://developer.pagerduty.com/api-reference/b3A6NDUwNDgxOQ-list-business-service-subscribers) allows you to subscribe users or teams to automatically receive updates about key business services.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as pagerduty from "@pulumi/pagerduty";
 *
 * const example = new pagerduty.BusinessService("example", {
 *     name: "My Web App",
 *     description: "A very descriptive description of this business service",
 *     pointOfContact: "PagerDuty Admin",
 *     team: "P37RSRS",
 * });
 * const engteam = new pagerduty.Team("engteam", {name: "Engineering"});
 * const exampleUser = new pagerduty.User("example", {
 *     name: "Earline Greenholt",
 *     email: "125.greenholt.earline@graham.name",
 * });
 * const teamExample = new pagerduty.BusinessServiceSubscriber("team_example", {
 *     subscriberId: engteam.id,
 *     subscriberType: "team",
 *     businessServiceId: example.id,
 * });
 * const userExample = new pagerduty.BusinessServiceSubscriber("user_example", {
 *     subscriberId: exampleUser.id,
 *     subscriberType: "user",
 *     businessServiceId: example.id,
 * });
 * ```
 *
 * ## Import
 *
 * Services can be imported using the `id` using the related business service ID, the subscriber type and the subscriber ID separated by a dot, e.g.
 *
 * ```sh
 * $ pulumi import pagerduty:index/businessServiceSubscriber:BusinessServiceSubscriber main PLBP09X.team.PLBP09X
 * ```
 */
export declare class BusinessServiceSubscriber extends pulumi.CustomResource {
    /**
     * Get an existing BusinessServiceSubscriber 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?: BusinessServiceSubscriberState, opts?: pulumi.CustomResourceOptions): BusinessServiceSubscriber;
    /**
     * Returns true if the given object is an instance of BusinessServiceSubscriber.  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 BusinessServiceSubscriber;
    /**
     * The ID of the business service to subscribe to.
     */
    readonly businessServiceId: pulumi.Output<string>;
    /**
     * The ID of the subscriber entity.
     */
    readonly subscriberId: pulumi.Output<string>;
    /**
     * Type of subscriber entity in the subscriber assignment. Possible values can be `user` and `team`.
     */
    readonly subscriberType: pulumi.Output<string>;
    /**
     * Create a BusinessServiceSubscriber 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: BusinessServiceSubscriberArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering BusinessServiceSubscriber resources.
 */
export interface BusinessServiceSubscriberState {
    /**
     * The ID of the business service to subscribe to.
     */
    businessServiceId?: pulumi.Input<string>;
    /**
     * The ID of the subscriber entity.
     */
    subscriberId?: pulumi.Input<string>;
    /**
     * Type of subscriber entity in the subscriber assignment. Possible values can be `user` and `team`.
     */
    subscriberType?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a BusinessServiceSubscriber resource.
 */
export interface BusinessServiceSubscriberArgs {
    /**
     * The ID of the business service to subscribe to.
     */
    businessServiceId: pulumi.Input<string>;
    /**
     * The ID of the subscriber entity.
     */
    subscriberId: pulumi.Input<string>;
    /**
     * Type of subscriber entity in the subscriber assignment. Possible values can be `user` and `team`.
     */
    subscriberType: pulumi.Input<string>;
}