@pulumi/vault/identity/groupMemberGroupIds.d.ts

A Pulumi package for creating and managing HashiCorp Vault cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages member groups for an Identity Group for Vault. The
 * [Identity secrets engine](https://www.vaultproject.io/docs/secrets/identity/index.html)
 * is the identity management solution for Vault.
 *
 * ## Example Usage
 *
 * ### Exclusive Member Groups
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vault from "@pulumi/vault";
 *
 * const internal = new vault.identity.Group("internal", {
 *     name: "internal",
 *     type: "internal",
 *     externalMemberGroupIds: true,
 *     metadata: {
 *         version: "2",
 *     },
 * });
 * const users = new vault.identity.Group("users", {
 *     name: "users",
 *     metadata: {
 *         version: "2",
 *     },
 * });
 * const members = new vault.identity.GroupMemberGroupIds("members", {
 *     exclusive: true,
 *     memberGroupIds: [users.id],
 *     groupId: internal.id,
 * });
 * ```
 *
 * ### Non-Exclusive Member Groups
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vault from "@pulumi/vault";
 *
 * const internal = new vault.identity.Group("internal", {
 *     name: "internal",
 *     type: "internal",
 *     externalMemberGroupIds: true,
 *     metadata: {
 *         version: "2",
 *     },
 * });
 * const users = new vault.identity.Group("users", {
 *     name: "users",
 *     metadata: {
 *         version: "2",
 *     },
 * });
 * const members = new vault.identity.GroupMemberGroupIds("members", {
 *     exclusive: false,
 *     memberGroupIds: [users.id],
 *     groupId: internal.id,
 * });
 * ```
 */
export declare class GroupMemberGroupIds extends pulumi.CustomResource {
    /**
     * Get an existing GroupMemberGroupIds 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?: GroupMemberGroupIdsState, opts?: pulumi.CustomResourceOptions): GroupMemberGroupIds;
    /**
     * Returns true if the given object is an instance of GroupMemberGroupIds.  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 GroupMemberGroupIds;
    /**
     * Defaults to `true`.
     *
     * If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
     * it equal to what is specified in the resource.
     *
     * If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
     * in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
     * are removed.
     */
    readonly exclusive: pulumi.Output<boolean | undefined>;
    /**
     * Group ID to assign member entities to.
     */
    readonly groupId: pulumi.Output<string>;
    /**
     * List of member groups that belong to the group
     */
    readonly memberGroupIds: pulumi.Output<string[] | undefined>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    readonly namespace: pulumi.Output<string | undefined>;
    /**
     * Create a GroupMemberGroupIds 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: GroupMemberGroupIdsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering GroupMemberGroupIds resources.
 */
export interface GroupMemberGroupIdsState {
    /**
     * Defaults to `true`.
     *
     * If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
     * it equal to what is specified in the resource.
     *
     * If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
     * in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
     * are removed.
     */
    exclusive?: pulumi.Input<boolean>;
    /**
     * Group ID to assign member entities to.
     */
    groupId?: pulumi.Input<string>;
    /**
     * List of member groups that belong to the group
     */
    memberGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a GroupMemberGroupIds resource.
 */
export interface GroupMemberGroupIdsArgs {
    /**
     * Defaults to `true`.
     *
     * If `true`, this resource will take exclusive control of the member groups that belong to the group and will set
     * it equal to what is specified in the resource.
     *
     * If set to `false`, this resource will simply ensure that the member groups specified in the resource are present
     * in the group. When destroying the resource, the resource will ensure that the member groups specified in the resource
     * are removed.
     */
    exclusive?: pulumi.Input<boolean>;
    /**
     * Group ID to assign member entities to.
     */
    groupId: pulumi.Input<string>;
    /**
     * List of member groups that belong to the group
     */
    memberGroupIds?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The namespace to provision the resource in.
     * The value should not contain leading or trailing forward slashes.
     * The `namespace` is always relative to the provider's configured [namespace](https://www.terraform.io/docs/providers/vault/index.html#namespace).
     * *Available only for Vault Enterprise*.
     */
    namespace?: pulumi.Input<string>;
}