pulumi-fusionauth/fusionAuthUserGroupMembership.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # User Group Membership Resource
 *
 * [User Group Membership API](https://fusionauth.io/docs/apis/groups#request-5)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "pulumi-fusionauth";
 *
 * const _this = new fusionauth.FusionAuthUserGroupMembership("this", {
 *     groupId: fusionauth_group["this"].id,
 *     userId: fusionauth_user["this"].id,
 * });
 * ```
 */
export declare class FusionAuthUserGroupMembership extends pulumi.CustomResource {
    /**
     * Get an existing FusionAuthUserGroupMembership 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?: FusionAuthUserGroupMembershipState, opts?: pulumi.CustomResourceOptions): FusionAuthUserGroupMembership;
    /**
     * Returns true if the given object is an instance of FusionAuthUserGroupMembership.  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 FusionAuthUserGroupMembership;
    /**
     * An object that can hold any information about the User for this membership that should be persisted.
     */
    readonly data: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The Id of the Group of this membership.
     */
    readonly groupId: pulumi.Output<string>;
    /**
     * The Id of the User Group Membership. If not provided, a random UUID will be generated.
     */
    readonly membershipId: pulumi.Output<string>;
    /**
     * "The Id of the User of this membership.
     */
    readonly userId: pulumi.Output<string>;
    /**
     * Create a FusionAuthUserGroupMembership 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: FusionAuthUserGroupMembershipArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FusionAuthUserGroupMembership resources.
 */
export interface FusionAuthUserGroupMembershipState {
    /**
     * An object that can hold any information about the User for this membership that should be persisted.
     */
    data?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The Id of the Group of this membership.
     */
    groupId?: pulumi.Input<string>;
    /**
     * The Id of the User Group Membership. If not provided, a random UUID will be generated.
     */
    membershipId?: pulumi.Input<string>;
    /**
     * "The Id of the User of this membership.
     */
    userId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FusionAuthUserGroupMembership resource.
 */
export interface FusionAuthUserGroupMembershipArgs {
    /**
     * An object that can hold any information about the User for this membership that should be persisted.
     */
    data?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * The Id of the Group of this membership.
     */
    groupId: pulumi.Input<string>;
    /**
     * The Id of the User Group Membership. If not provided, a random UUID will be generated.
     */
    membershipId?: pulumi.Input<string>;
    /**
     * "The Id of the User of this membership.
     */
    userId: pulumi.Input<string>;
}