@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
121 lines (120 loc) • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Use this data source to get information about a specific [team](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIyMw-list-teams) that you can use for other PagerDuty resources.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const me = pagerduty.getUser({
* email: "me@example.com",
* });
* const devops = pagerduty.getTeam({
* name: "devops",
* });
* const foo = new pagerduty.EscalationPolicy("foo", {
* name: "DevOps Escalation Policy",
* numLoops: 2,
* teams: devops.then(devops => devops.id),
* rules: [{
* escalationDelayInMinutes: 10,
* targets: [{
* type: "user",
* id: me.then(me => me.id),
* }],
* }],
* });
* ```
*/
export declare function getTeam(args: GetTeamArgs, opts?: pulumi.InvokeOptions): Promise<GetTeamResult>;
/**
* A collection of arguments for invoking getTeam.
*/
export interface GetTeamArgs {
/**
* (Optional) 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?: string;
/**
* The name of the team to find in the PagerDuty API.
*/
name: 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?: string;
}
/**
* A collection of values returned by getTeam.
*/
export interface GetTeamResult {
/**
* (Optional) 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?: string;
/**
* A description of the found team.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* The name of the found team.
*/
readonly name: 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?: string;
}
/**
* Use this data source to get information about a specific [team](https://developer.pagerduty.com/api-reference/b3A6Mjc0ODIyMw-list-teams) that you can use for other PagerDuty resources.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const me = pagerduty.getUser({
* email: "me@example.com",
* });
* const devops = pagerduty.getTeam({
* name: "devops",
* });
* const foo = new pagerduty.EscalationPolicy("foo", {
* name: "DevOps Escalation Policy",
* numLoops: 2,
* teams: devops.then(devops => devops.id),
* rules: [{
* escalationDelayInMinutes: 10,
* targets: [{
* type: "user",
* id: me.then(me => me.id),
* }],
* }],
* });
* ```
*/
export declare function getTeamOutput(args: GetTeamOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTeamResult>;
/**
* A collection of arguments for invoking getTeam.
*/
export interface GetTeamOutputArgs {
/**
* (Optional) 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>;
/**
* The name of the team to find in the PagerDuty API.
*/
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>;
}