1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/teams
  7. Role

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi

    UpdateTeamRoles upserts the role assigned to a team since we currently only support a 1:1 mapping of teams to roles.

    Create Role Resource

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

    Constructor syntax

    new Role(name: string, args: RoleArgs, opts?: CustomResourceOptions);
    @overload
    def Role(resource_name: str,
             args: RoleArgs,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Role(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             org_name: Optional[str] = None,
             role_id: Optional[str] = None,
             team_name: Optional[str] = None)
    func NewRole(ctx *Context, name string, args RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs args, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
    public Role(String name, RoleArgs args, CustomResourceOptions options)
    
    type: pulumiservice:api/teams:Role
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "pulumiservice_api_teams_role" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RoleArgs
    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 RoleArgs
    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 RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    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 roleResource = new PulumiService.Api.Teams.Role("roleResource", new()
    {
        OrgName = "string",
        RoleID = "string",
        TeamName = "string",
    });
    
    example, err := teams.NewRole(ctx, "roleResource", &teams.RoleArgs{
    	OrgName:  pulumi.String("string"),
    	RoleID:   pulumi.String("string"),
    	TeamName: pulumi.String("string"),
    })
    
    resource "pulumiservice_api_teams_role" "roleResource" {
      org_name  = "string"
      role_id   = "string"
      team_name = "string"
    }
    
    var roleResource = new Role("roleResource", RoleArgs.builder()
        .orgName("string")
        .roleID("string")
        .teamName("string")
        .build());
    
    role_resource = pulumiservice.api.teams.Role("roleResource",
        org_name="string",
        role_id="string",
        team_name="string")
    
    const roleResource = new pulumiservice.api.teams.Role("roleResource", {
        orgName: "string",
        roleID: "string",
        teamName: "string",
    });
    
    type: pulumiservice:api/teams:Role
    properties:
        orgName: string
        roleID: string
        teamName: string
    

    Role Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Role resource accepts the following input properties:

    OrgName string
    The organization name
    RoleID string
    The role identifier
    TeamName string
    The team name
    OrgName string
    The organization name
    RoleID string
    The role identifier
    TeamName string
    The team name
    org_name string
    The organization name
    role_id string
    The role identifier
    team_name string
    The team name
    orgName String
    The organization name
    roleID String
    The role identifier
    teamName String
    The team name
    orgName string
    The organization name
    roleID string
    The role identifier
    teamName string
    The team name
    org_name str
    The organization name
    role_id str
    The role identifier
    team_name str
    The team name
    orgName String
    The organization name
    roleID String
    The role identifier
    teamName String
    The team name

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Role 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 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.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial