@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
126 lines (125 loc) • 4.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A [team](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIyMg-create-a-team) is a collection of users and escalation policies that represent a group of people within an organization.
*
* The account must have the `teams` ability to use the following resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const parent = new pagerduty.Team("parent", {
* name: "Product Development",
* description: "Product and Engineering",
* });
* const example = new pagerduty.Team("example", {
* name: "Engineering",
* description: "All engineering",
* parent: parent.id,
* });
* ```
*
* ## Import
*
* Teams can be imported using the `id`, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/team:Team main PLBP09X
* ```
*/
export declare class Team extends pulumi.CustomResource {
/**
* Get an existing Team 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?: TeamState, opts?: pulumi.CustomResourceOptions): Team;
/**
* Returns true if the given object is an instance of Team. 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 Team;
/**
* The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
*/
readonly defaultRole: pulumi.Output<string>;
/**
* A human-friendly description of the team.
* If not set, a placeholder of "Managed by Pulumi" will be set.
*/
readonly description: pulumi.Output<string>;
/**
* URL at which the entity is uniquely displayed in the Web app
*/
readonly htmlUrl: pulumi.Output<string>;
/**
* The name of the group.
*/
readonly name: pulumi.Output<string>;
/**
* ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
*/
readonly parent: pulumi.Output<string | undefined>;
/**
* Create a Team 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?: TeamArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Team resources.
*/
export interface TeamState {
/**
* The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
*/
defaultRole?: pulumi.Input<string>;
/**
* A human-friendly description of the team.
* If not set, a placeholder of "Managed by Pulumi" will be set.
*/
description?: pulumi.Input<string>;
/**
* URL at which the entity is uniquely displayed in the Web app
*/
htmlUrl?: pulumi.Input<string>;
/**
* The name of the group.
*/
name?: pulumi.Input<string>;
/**
* ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
*/
parent?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Team resource.
*/
export interface TeamArgs {
/**
* The team is private if the value is "none", or public if it is "manager" (the default permissions for a non-member of the team are either "none", or their base role up until "manager").
*/
defaultRole?: pulumi.Input<string>;
/**
* A human-friendly description of the team.
* If not set, a placeholder of "Managed by Pulumi" will be set.
*/
description?: pulumi.Input<string>;
/**
* The name of the group.
*/
name?: pulumi.Input<string>;
/**
* ID of the parent team. This is available to accounts with the Team Hierarchy feature enabled. Please contact your account manager for more information.
*/
parent?: pulumi.Input<string>;
}