@pulumi/pulumiservice
Version:
90 lines (89 loc) • 3.29 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The Pulumi Cloud offers role-based access control (RBAC) using teams. Teams allow organization admins to assign a set of stack permissions to a group of users.
*/
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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, 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;
/**
* Optional. Team description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Optional. Team display name.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
*/
readonly githubTeamId: pulumi.Output<number | undefined>;
/**
* List of Pulumi Cloud usernames of team members.
*/
readonly members: pulumi.Output<string[]>;
/**
* The team's name. Required for "pulumi" teams.
*/
readonly name: pulumi.Output<string | undefined>;
/**
* The name of the Pulumi organization the team belongs to.
*/
readonly organizationName: pulumi.Output<string>;
/**
* The type of team. Must be either `pulumi` or `github`.
*/
readonly teamType: pulumi.Output<string>;
/**
* 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);
}
/**
* The set of arguments for constructing a Team resource.
*/
export interface TeamArgs {
/**
* Optional. Team description.
*/
description?: pulumi.Input<string>;
/**
* Optional. Team display name.
*/
displayName?: pulumi.Input<string>;
/**
* The GitHub ID of the team to mirror. Must be in the same GitHub organization that the Pulumi org is backed by. Required for "github" teams.
*/
githubTeamId?: pulumi.Input<number>;
/**
* List of Pulumi Cloud usernames of team members.
*/
members?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The team's name. Required for "pulumi" teams.
*/
name?: pulumi.Input<string>;
/**
* The name of the Pulumi organization the team belongs to.
*/
organizationName: pulumi.Input<string>;
/**
* The type of team. Must be either `pulumi` or `github`.
*/
teamType: pulumi.Input<string>;
}