UNPKG

@pulumi/pulumiservice

Version:

[![Slack](http://www.pulumi.com/images/docs/badges/slack.svg)](https://slack.pulumi.com) [![NPM version](https://badge.fury.io/js/%40pulumi%2Fpulumiservice.svg)](https://www.npmjs.com/package/@pulumi/pulumiservice) [![Python version](https://badge.fury.io

82 lines 3.59 kB
import * as pulumi from "@pulumi/pulumi"; /** * Manages a user's membership in a Pulumi Cloud organization and their assigned role. The user must already have a Pulumi Cloud account before they can be added. Custom (fine-grained) roles are assigned by setting `roleId`; built-in roles are assigned by setting `role`. When both are set, `roleId` takes precedence. */ export declare class OrganizationMember extends pulumi.CustomResource { /** * Get an existing OrganizationMember 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): OrganizationMember; /** * Returns true if the given object is an instance of OrganizationMember. 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 OrganizationMember; /** * True when this resource adopted an existing organization member (the user was already in the org at Create time). Adopted memberships are left in place on destroy; only the role is reset. */ readonly adopted: pulumi.Output<boolean>; /** * The member's email address. */ readonly email: pulumi.Output<string>; /** * The member's display name. */ readonly name: pulumi.Output<string>; /** * The Pulumi Cloud organization name. */ readonly organizationName: pulumi.Output<string>; /** * The built-in organization role. One of `member`, `admin`, `billing-manager`. Defaults to `member` on create. Ignored when `roleId` is set. */ readonly role: pulumi.Output<string | undefined>; /** * The ID of a custom (fine-grained) organization role to assign. Takes precedence over `role`. */ readonly roleId: pulumi.Output<string | undefined>; /** * The name of the currently assigned role (custom role name, or built-in role). */ readonly roleName: pulumi.Output<string>; /** * The Pulumi Cloud username of the member. */ readonly username: pulumi.Output<string>; /** * Create a OrganizationMember 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: OrganizationMemberArgs, opts?: pulumi.CustomResourceOptions); } /** * The set of arguments for constructing a OrganizationMember resource. */ export interface OrganizationMemberArgs { /** * The Pulumi Cloud organization name. */ organizationName: pulumi.Input<string>; /** * The built-in organization role. One of `member`, `admin`, `billing-manager`. Defaults to `member` on create. Ignored when `roleId` is set. */ role?: pulumi.Input<string | undefined>; /** * The ID of a custom (fine-grained) organization role to assign. Takes precedence over `role`. */ roleId?: pulumi.Input<string | undefined>; /** * The Pulumi Cloud username of the member. */ username: pulumi.Input<string>; } //# sourceMappingURL=organizationMember.d.ts.map