1. Packages
  2. PagerDuty
  3. API Docs
  4. TeamMembership
PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi

pagerduty.TeamMembership

Explore with Pulumi AI

pagerduty logo
PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi

    Example Usage

    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 pulumi
    import pulumi_pagerduty as pagerduty
    
    foo = pagerduty.User("foo",
        name="foo",
        email="foo@bar.com")
    foo_team = pagerduty.Team("foo",
        name="foo",
        description="foo")
    foo_team_membership = pagerduty.TeamMembership("foo",
        user_id=foo.id,
        team_id=foo_team.id,
        role="manager")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-pagerduty/sdk/v4/go/pagerduty"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		foo, err := pagerduty.NewUser(ctx, "foo", &pagerduty.UserArgs{
    			Name:  pulumi.String("foo"),
    			Email: pulumi.String("foo@bar.com"),
    		})
    		if err != nil {
    			return err
    		}
    		fooTeam, err := pagerduty.NewTeam(ctx, "foo", &pagerduty.TeamArgs{
    			Name:        pulumi.String("foo"),
    			Description: pulumi.String("foo"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = pagerduty.NewTeamMembership(ctx, "foo", &pagerduty.TeamMembershipArgs{
    			UserId: foo.ID(),
    			TeamId: fooTeam.ID(),
    			Role:   pulumi.String("manager"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Pagerduty = Pulumi.Pagerduty;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Pagerduty.User("foo", new()
        {
            Name = "foo",
            Email = "foo@bar.com",
        });
    
        var fooTeam = new Pagerduty.Team("foo", new()
        {
            Name = "foo",
            Description = "foo",
        });
    
        var fooTeamMembership = new Pagerduty.TeamMembership("foo", new()
        {
            UserId = foo.Id,
            TeamId = fooTeam.Id,
            Role = "manager",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.pagerduty.User;
    import com.pulumi.pagerduty.UserArgs;
    import com.pulumi.pagerduty.Team;
    import com.pulumi.pagerduty.TeamArgs;
    import com.pulumi.pagerduty.TeamMembership;
    import com.pulumi.pagerduty.TeamMembershipArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo = new User("foo", UserArgs.builder()
                .name("foo")
                .email("foo@bar.com")
                .build());
    
            var fooTeam = new Team("fooTeam", TeamArgs.builder()
                .name("foo")
                .description("foo")
                .build());
    
            var fooTeamMembership = new TeamMembership("fooTeamMembership", TeamMembershipArgs.builder()
                .userId(foo.id())
                .teamId(fooTeam.id())
                .role("manager")
                .build());
    
        }
    }
    
    resources:
      foo:
        type: pagerduty:User
        properties:
          name: foo
          email: foo@bar.com
      fooTeam:
        type: pagerduty:Team
        name: foo
        properties:
          name: foo
          description: foo
      fooTeamMembership:
        type: pagerduty:TeamMembership
        name: foo
        properties:
          userId: ${foo.id}
          teamId: ${fooTeam.id}
          role: manager
    

    Create TeamMembership Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TeamMembership(name: string, args: TeamMembershipArgs, opts?: CustomResourceOptions);
    @overload
    def TeamMembership(resource_name: str,
                       args: TeamMembershipArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def TeamMembership(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       team_id: Optional[str] = None,
                       user_id: Optional[str] = None,
                       role: Optional[str] = None)
    func NewTeamMembership(ctx *Context, name string, args TeamMembershipArgs, opts ...ResourceOption) (*TeamMembership, error)
    public TeamMembership(string name, TeamMembershipArgs args, CustomResourceOptions? opts = null)
    public TeamMembership(String name, TeamMembershipArgs args)
    public TeamMembership(String name, TeamMembershipArgs args, CustomResourceOptions options)
    
    type: pagerduty:TeamMembership
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TeamMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TeamMembershipArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TeamMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamMembershipArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var teamMembershipResource = new Pagerduty.TeamMembership("teamMembershipResource", new()
    {
        TeamId = "string",
        UserId = "string",
        Role = "string",
    });
    
    example, err := pagerduty.NewTeamMembership(ctx, "teamMembershipResource", &pagerduty.TeamMembershipArgs{
    	TeamId: pulumi.String("string"),
    	UserId: pulumi.String("string"),
    	Role:   pulumi.String("string"),
    })
    
    var teamMembershipResource = new TeamMembership("teamMembershipResource", TeamMembershipArgs.builder()
        .teamId("string")
        .userId("string")
        .role("string")
        .build());
    
    team_membership_resource = pagerduty.TeamMembership("teamMembershipResource",
        team_id="string",
        user_id="string",
        role="string")
    
    const teamMembershipResource = new pagerduty.TeamMembership("teamMembershipResource", {
        teamId: "string",
        userId: "string",
        role: "string",
    });
    
    type: pagerduty:TeamMembership
    properties:
        role: string
        teamId: string
        userId: string
    

    TeamMembership Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The TeamMembership resource accepts the following input properties:

    TeamId string
    The ID of the team in which the user will belong.
    UserId string
    The ID of the user to add to the team.
    Role string
    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 limited_user is a Team role of responder
    TeamId string
    The ID of the team in which the user will belong.
    UserId string
    The ID of the user to add to the team.
    Role string
    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 limited_user is a Team role of responder
    teamId String
    The ID of the team in which the user will belong.
    userId String
    The ID of the user to add to the team.
    role String
    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 limited_user is a Team role of responder
    teamId string
    The ID of the team in which the user will belong.
    userId string
    The ID of the user to add to the team.
    role string
    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 limited_user is a Team role of responder
    team_id str
    The ID of the team in which the user will belong.
    user_id str
    The ID of the user to add to the team.
    role str
    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 limited_user is a Team role of responder
    teamId String
    The ID of the team in which the user will belong.
    userId String
    The ID of the user to add to the team.
    role String
    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 limited_user is a Team role of responder

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TeamMembership resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TeamMembership Resource

    Get an existing TeamMembership resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TeamMembershipState, opts?: CustomResourceOptions): TeamMembership
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            role: Optional[str] = None,
            team_id: Optional[str] = None,
            user_id: Optional[str] = None) -> TeamMembership
    func GetTeamMembership(ctx *Context, name string, id IDInput, state *TeamMembershipState, opts ...ResourceOption) (*TeamMembership, error)
    public static TeamMembership Get(string name, Input<string> id, TeamMembershipState? state, CustomResourceOptions? opts = null)
    public static TeamMembership get(String name, Output<String> id, TeamMembershipState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Role string
    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 limited_user is a Team role of responder
    TeamId string
    The ID of the team in which the user will belong.
    UserId string
    The ID of the user to add to the team.
    Role string
    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 limited_user is a Team role of responder
    TeamId string
    The ID of the team in which the user will belong.
    UserId string
    The ID of the user to add to the team.
    role String
    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 limited_user is a Team role of responder
    teamId String
    The ID of the team in which the user will belong.
    userId String
    The ID of the user to add to the team.
    role string
    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 limited_user is a Team role of responder
    teamId string
    The ID of the team in which the user will belong.
    userId string
    The ID of the user to add to the team.
    role str
    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 limited_user is a Team role of responder
    team_id str
    The ID of the team in which the user will belong.
    user_id str
    The ID of the user to add to the team.
    role String
    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 limited_user is a Team role of responder
    teamId String
    The ID of the team in which the user will belong.
    userId String
    The ID of the user to add to the team.

    Import

    Team memberships can be imported using the user_id and team_id, e.g.

    $ pulumi import pagerduty:index/teamMembership:TeamMembership main PLBP09X:PLB09Z
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    PagerDuty pulumi/pulumi-pagerduty
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the pagerduty Terraform Provider.
    pagerduty logo
    PagerDuty v4.13.2 published on Thursday, Jun 27, 2024 by Pulumi