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

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

import * as pulumi from "@pulumi/pulumi";
/**
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as vault from "@pulumi/vault";
 *
 * const test = new vault.identity.Entity("test", {
 *     name: "tester1",
 *     policies: ["test"],
 *     metadata: {
 *         foo: "bar",
 *     },
 * });
 * ```
 *
 * ## Import
 *
 * Identity entity can be imported using the `id`, e.g.
 *
 * ```sh
 * $ pulumi import vault:identity/entity:Entity test "ae6f8ued-0f1a-9f6b-2915-1a2be20dc053"
 * ```
 */
export declare class Entity extends pulumi.CustomResource {
    /**
     * Get an existing Entity 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?: EntityState, opts?: pulumi.CustomResourceOptions): Entity;
    /**
     * Returns true if the given object is an instance of Entity.  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 Entity;
    /**
     * True/false Is this entity currently disabled. Defaults to `false`
     */
    readonly disabled: pulumi.Output<boolean | undefined>;
    /**
     * `false` by default. If set to `true`, this resource will ignore any policies return from Vault or specified in the resource. You can use `vault.identity.EntityPolicies` to manage policies for this entity in a decoupled manner.
     */
    readonly externalPolicies: pulumi.Output<boolean | undefined>;
    /**
     * A Map of additional metadata to associate with the user.
     */
    readonly metadata: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * Name of the identity entity to create.
     */
    readonly name: pulumi.Output<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*.
     */
    readonly namespace: pulumi.Output<string | undefined>;
    /**
     * A list of policies to apply to the entity.
     */
    readonly policies: pulumi.Output<string[] | undefined>;
    /**
     * Create a Entity 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?: EntityArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Entity resources.
 */
export interface EntityState {
    /**
     * True/false Is this entity currently disabled. Defaults to `false`
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * `false` by default. If set to `true`, this resource will ignore any policies return from Vault or specified in the resource. You can use `vault.identity.EntityPolicies` to manage policies for this entity in a decoupled manner.
     */
    externalPolicies?: pulumi.Input<boolean>;
    /**
     * A Map of additional metadata to associate with the user.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the identity entity to create.
     */
    name?: 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>;
    /**
     * A list of policies to apply to the entity.
     */
    policies?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
 * The set of arguments for constructing a Entity resource.
 */
export interface EntityArgs {
    /**
     * True/false Is this entity currently disabled. Defaults to `false`
     */
    disabled?: pulumi.Input<boolean>;
    /**
     * `false` by default. If set to `true`, this resource will ignore any policies return from Vault or specified in the resource. You can use `vault.identity.EntityPolicies` to manage policies for this entity in a decoupled manner.
     */
    externalPolicies?: pulumi.Input<boolean>;
    /**
     * A Map of additional metadata to associate with the user.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * Name of the identity entity to create.
     */
    name?: 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>;
    /**
     * A list of policies to apply to the entity.
     */
    policies?: pulumi.Input<pulumi.Input<string>[]>;
}