@pulumi/openstack
Version:
A Pulumi package for creating and managing OpenStack cloud resources.
126 lines (125 loc) • 4.55 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages a user membership to group V3 resource within OpenStack.
*
* > **Note:** You _must_ have admin privileges in your OpenStack cloud to use
* this resource.
*
* ***
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as openstack from "@pulumi/openstack";
*
* const project1 = new openstack.identity.Project("project_1", {name: "project_1"});
* const user1 = new openstack.identity.User("user_1", {
* name: "user_1",
* defaultProjectId: project1.id,
* });
* const group1 = new openstack.identity.GroupV3("group_1", {
* name: "group_1",
* description: "group 1",
* });
* const role1 = new openstack.identity.Role("role_1", {name: "role_1"});
* const userMembership1 = new openstack.identity.UserMembershipV3("user_membership_1", {
* userId: user1.id,
* groupId: group1.id,
* });
* const roleAssignment1 = new openstack.identity.RoleAssignment("role_assignment_1", {
* groupId: group1.id,
* projectId: project1.id,
* roleId: role1.id,
* });
* ```
*
* ## Import
*
* This resource can be imported by specifying all two arguments, separated
* by a forward slash:
*
* ```sh
* $ pulumi import openstack:identity/userMembershipV3:UserMembershipV3 user_membership_1 user_id/group_id
* ```
*/
export declare class UserMembershipV3 extends pulumi.CustomResource {
/**
* Get an existing UserMembershipV3 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?: UserMembershipV3State, opts?: pulumi.CustomResourceOptions): UserMembershipV3;
/**
* Returns true if the given object is an instance of UserMembershipV3. 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 UserMembershipV3;
/**
* The UUID of group to which the user will be added.
* Changing this creates a new user membership.
*/
readonly groupId: pulumi.Output<string>;
/**
* The region in which to obtain the V3 Identity client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new user membership.
*/
readonly region: pulumi.Output<string>;
/**
* The UUID of user to use. Changing this creates a new user membership.
*/
readonly userId: pulumi.Output<string>;
/**
* Create a UserMembershipV3 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: UserMembershipV3Args, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering UserMembershipV3 resources.
*/
export interface UserMembershipV3State {
/**
* The UUID of group to which the user will be added.
* Changing this creates a new user membership.
*/
groupId?: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Identity client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new user membership.
*/
region?: pulumi.Input<string>;
/**
* The UUID of user to use. Changing this creates a new user membership.
*/
userId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a UserMembershipV3 resource.
*/
export interface UserMembershipV3Args {
/**
* The UUID of group to which the user will be added.
* Changing this creates a new user membership.
*/
groupId: pulumi.Input<string>;
/**
* The region in which to obtain the V3 Identity client.
* If omitted, the `region` argument of the provider is used.
* Changing this creates a new user membership.
*/
region?: pulumi.Input<string>;
/**
* The UUID of user to use. Changing this creates a new user membership.
*/
userId: pulumi.Input<string>;
}