@pulumi/pagerduty
Version:
A Pulumi package for creating and managing pagerduty cloud resources.
112 lines (111 loc) • 4.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as pagerduty from "@pulumi/pagerduty";
*
* const foo = new pagerduty.User("foo", {
* name: "foo",
* email: "foo@bar.com",
* });
* const fooTeam = new pagerduty.Team("foo", {
* name: "foo",
* description: "foo",
* });
* const fooTeamMembership = new pagerduty.TeamMembership("foo", {
* userId: foo.id,
* teamId: fooTeam.id,
* role: "manager",
* });
* ```
*
* ## Import
*
* Team memberships can be imported using the `user_id` and `team_id`, e.g.
*
* ```sh
* $ pulumi import pagerduty:index/teamMembership:TeamMembership main PLBP09X:PLB09Z
* ```
*/
export declare class TeamMembership extends pulumi.CustomResource {
/**
* Get an existing TeamMembership 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?: TeamMembershipState, opts?: pulumi.CustomResourceOptions): TeamMembership;
/**
* Returns true if the given object is an instance of TeamMembership. 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 TeamMembership;
/**
* The role of the user in the team. One of `observer`, `responder`, or `manager`. Defaults to `manager`.
* These roles match up to user roles in the following ways:
* * User role of `user` is a Team role of `manager`
* * User role of `limitedUser` is a Team role of `responder`
*/
readonly role: pulumi.Output<string>;
/**
* The ID of the team in which the user will belong.
*/
readonly teamId: pulumi.Output<string>;
/**
* The ID of the user to add to the team.
*/
readonly userId: pulumi.Output<string>;
/**
* Create a TeamMembership 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: TeamMembershipArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TeamMembership resources.
*/
export interface TeamMembershipState {
/**
* The role of the user in the team. One of `observer`, `responder`, or `manager`. Defaults to `manager`.
* These roles match up to user roles in the following ways:
* * User role of `user` is a Team role of `manager`
* * User role of `limitedUser` is a Team role of `responder`
*/
role?: pulumi.Input<string>;
/**
* The ID of the team in which the user will belong.
*/
teamId?: pulumi.Input<string>;
/**
* The ID of the user to add to the team.
*/
userId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a TeamMembership resource.
*/
export interface TeamMembershipArgs {
/**
* The role of the user in the team. One of `observer`, `responder`, or `manager`. Defaults to `manager`.
* These roles match up to user roles in the following ways:
* * User role of `user` is a Team role of `manager`
* * User role of `limitedUser` is a Team role of `responder`
*/
role?: pulumi.Input<string>;
/**
* The ID of the team in which the user will belong.
*/
teamId: pulumi.Input<string>;
/**
* The ID of the user to add to the team.
*/
userId: pulumi.Input<string>;
}