@equinix-labs/pulumi-equinix
Version:
A Pulumi package for creating and managing equinix cloud resources.
174 lines (173 loc) • 6.24 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manage the membership of existing and new invitees within an Equinix Metal organization and its projects.
*
* ## Example Usage
* ### example 1
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const member = new equinix.metal.OrganizationMember("member", {
* invitee: "member@example.com",
* roles: ["limited_collaborator"],
* projectsIds: [projectId],
* organizationId: organizationId,
* });
* ```
* ### example 2
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as equinix from "@equinix-labs/pulumi-equinix";
*
* const owner = new equinix.metal.OrganizationMember("owner", {
* invitee: "admin@example.com",
* roles: ["owner"],
* projectsIds: [],
* organizationId: organizationId,
* });
* ```
*
* ## Import
*
* This resource can be imported using the `invitee` and `organization_id` as colon separated arguments:
*
* ```sh
* $ pulumi import equinix:metal/organizationMember:OrganizationMember resource_name {invitee}:{organization_id}
* ```
*/
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 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?: OrganizationMemberState, 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;
/**
* When the invitation was created (only known in the invitation stage)
*/
readonly created: pulumi.Output<string>;
/**
* The userId of the user that sent the invitation (only known in the invitation stage)
*/
readonly invitedBy: pulumi.Output<string>;
/**
* The email address of the user to invite
*/
readonly invitee: pulumi.Output<string>;
/**
* A message to include in the emailed invitation.
*/
readonly message: pulumi.Output<string | undefined>;
/**
* The nonce for the invitation (only known in the invitation stage)
*/
readonly nonce: pulumi.Output<string>;
/**
* The organization to invite the user to
*/
readonly organizationId: pulumi.Output<string>;
/**
* Project IDs the member has access to within the organization. If the member is an 'admin', the projects list should be empty.
*/
readonly projectsIds: pulumi.Output<string[]>;
/**
* Organization roles (admin, collaborator, limited_collaborator, billing)
*/
readonly roles: pulumi.Output<string[]>;
/**
* The state of the membership ('invited' when an invitation is open, 'active' when the user is an organization member)
*/
readonly state: pulumi.Output<string>;
/**
* When the invitation was updated (only known in the invitation stage)
*/
readonly updated: 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);
}
/**
* Input properties used for looking up and filtering OrganizationMember resources.
*/
export interface OrganizationMemberState {
/**
* When the invitation was created (only known in the invitation stage)
*/
created?: pulumi.Input<string>;
/**
* The userId of the user that sent the invitation (only known in the invitation stage)
*/
invitedBy?: pulumi.Input<string>;
/**
* The email address of the user to invite
*/
invitee?: pulumi.Input<string>;
/**
* A message to include in the emailed invitation.
*/
message?: pulumi.Input<string>;
/**
* The nonce for the invitation (only known in the invitation stage)
*/
nonce?: pulumi.Input<string>;
/**
* The organization to invite the user to
*/
organizationId?: pulumi.Input<string>;
/**
* Project IDs the member has access to within the organization. If the member is an 'admin', the projects list should be empty.
*/
projectsIds?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Organization roles (admin, collaborator, limited_collaborator, billing)
*/
roles?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The state of the membership ('invited' when an invitation is open, 'active' when the user is an organization member)
*/
state?: pulumi.Input<string>;
/**
* When the invitation was updated (only known in the invitation stage)
*/
updated?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a OrganizationMember resource.
*/
export interface OrganizationMemberArgs {
/**
* The email address of the user to invite
*/
invitee: pulumi.Input<string>;
/**
* A message to include in the emailed invitation.
*/
message?: pulumi.Input<string>;
/**
* The organization to invite the user to
*/
organizationId: pulumi.Input<string>;
/**
* Project IDs the member has access to within the organization. If the member is an 'admin', the projects list should be empty.
*/
projectsIds: pulumi.Input<pulumi.Input<string>[]>;
/**
* Organization roles (admin, collaborator, limited_collaborator, billing)
*/
roles: pulumi.Input<pulumi.Input<string>[]>;
}