pulumi-infisical/bin/secret.d.ts

A Pulumi provider for managing Infisical secrets management platform, dynamically bridged from the Terraform Infisical provider with support for projects, secrets, identity management, integrations, and access controls.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
export declare class Secret extends pulumi.CustomResource {
    /**
     * Get an existing Secret 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?: SecretState, opts?: pulumi.CustomResourceOptions): Secret;
    /**
     * Returns true if the given object is an instance of Secret.  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 Secret;
    /**
     * The environment slug of the secret to modify/create
     */
    readonly envSlug: pulumi.Output<string>;
    /**
     * The path to the folder where the given secret resides
     */
    readonly folderPath: pulumi.Output<string>;
    /**
     * The last time the secret was updated.
     */
    readonly lastUpdated: pulumi.Output<string>;
    /**
     * Metadata associated with the secret as key-value pairs.
     */
    readonly metadata: pulumi.Output<{
        [key: string]: string;
    } | undefined>;
    /**
     * The name of the secret
     */
    readonly name: pulumi.Output<string>;
    readonly secretReminder: pulumi.Output<outputs.SecretSecretReminder | undefined>;
    /**
     * Tag ids to be attached for the secrets.
     */
    readonly tagIds: pulumi.Output<string[] | undefined>;
    /**
     * The value of the secret in plain text. This is required if <span pulumi-lang-nodejs="`valueWo`" pulumi-lang-dotnet="`ValueWo`" pulumi-lang-go="`valueWo`" pulumi-lang-python="`value_wo`" pulumi-lang-yaml="`valueWo`" pulumi-lang-java="`valueWo`" pulumi-lang-hcl="`value_wo`">`valueWo`</span> is not set.
     */
    readonly value: pulumi.Output<string | undefined>;
    /**
     * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
     * The value of the secret in plain text as a write-only secret. If set, the secret value will not be stored in state. This is required if <span pulumi-lang-nodejs="`value`" pulumi-lang-dotnet="`Value`" pulumi-lang-go="`value`" pulumi-lang-python="`value`" pulumi-lang-yaml="`value`" pulumi-lang-java="`value`" pulumi-lang-hcl="`value`">`value`</span> is not set. Requires Terraform version 1.11.0 or higher.
     */
    readonly valueWo: pulumi.Output<string | undefined>;
    /**
     * Used together with<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>to trigger an update. Increment this value when an update to the<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>is required.
     */
    readonly valueWoVersion: pulumi.Output<number | undefined>;
    /**
     * The Infisical project ID (Required for Machine Identity auth, and service tokens with multiple scopes)
     */
    readonly workspaceId: pulumi.Output<string>;
    /**
     * Create a Secret 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: SecretArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Secret resources.
 */
export interface SecretState {
    /**
     * The environment slug of the secret to modify/create
     */
    envSlug?: pulumi.Input<string | undefined>;
    /**
     * The path to the folder where the given secret resides
     */
    folderPath?: pulumi.Input<string | undefined>;
    /**
     * The last time the secret was updated.
     */
    lastUpdated?: pulumi.Input<string | undefined>;
    /**
     * Metadata associated with the secret as key-value pairs.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The name of the secret
     */
    name?: pulumi.Input<string | undefined>;
    secretReminder?: pulumi.Input<inputs.SecretSecretReminder | undefined>;
    /**
     * Tag ids to be attached for the secrets.
     */
    tagIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The value of the secret in plain text. This is required if <span pulumi-lang-nodejs="`valueWo`" pulumi-lang-dotnet="`ValueWo`" pulumi-lang-go="`valueWo`" pulumi-lang-python="`value_wo`" pulumi-lang-yaml="`valueWo`" pulumi-lang-java="`valueWo`" pulumi-lang-hcl="`value_wo`">`valueWo`</span> is not set.
     */
    value?: pulumi.Input<string | undefined>;
    /**
     * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
     * The value of the secret in plain text as a write-only secret. If set, the secret value will not be stored in state. This is required if <span pulumi-lang-nodejs="`value`" pulumi-lang-dotnet="`Value`" pulumi-lang-go="`value`" pulumi-lang-python="`value`" pulumi-lang-yaml="`value`" pulumi-lang-java="`value`" pulumi-lang-hcl="`value`">`value`</span> is not set. Requires Terraform version 1.11.0 or higher.
     */
    valueWo?: pulumi.Input<string | undefined>;
    /**
     * Used together with<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>to trigger an update. Increment this value when an update to the<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>is required.
     */
    valueWoVersion?: pulumi.Input<number | undefined>;
    /**
     * The Infisical project ID (Required for Machine Identity auth, and service tokens with multiple scopes)
     */
    workspaceId?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a Secret resource.
 */
export interface SecretArgs {
    /**
     * The environment slug of the secret to modify/create
     */
    envSlug: pulumi.Input<string>;
    /**
     * The path to the folder where the given secret resides
     */
    folderPath: pulumi.Input<string>;
    /**
     * Metadata associated with the secret as key-value pairs.
     */
    metadata?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    } | undefined>;
    /**
     * The name of the secret
     */
    name?: pulumi.Input<string | undefined>;
    secretReminder?: pulumi.Input<inputs.SecretSecretReminder | undefined>;
    /**
     * Tag ids to be attached for the secrets.
     */
    tagIds?: pulumi.Input<pulumi.Input<string>[] | undefined>;
    /**
     * The value of the secret in plain text. This is required if <span pulumi-lang-nodejs="`valueWo`" pulumi-lang-dotnet="`ValueWo`" pulumi-lang-go="`valueWo`" pulumi-lang-python="`value_wo`" pulumi-lang-yaml="`valueWo`" pulumi-lang-java="`valueWo`" pulumi-lang-hcl="`value_wo`">`valueWo`</span> is not set.
     */
    value?: pulumi.Input<string | undefined>;
    /**
     * **NOTE:** This field is write-only and its value will not be updated in state as part of read operations.
     * The value of the secret in plain text as a write-only secret. If set, the secret value will not be stored in state. This is required if <span pulumi-lang-nodejs="`value`" pulumi-lang-dotnet="`Value`" pulumi-lang-go="`value`" pulumi-lang-python="`value`" pulumi-lang-yaml="`value`" pulumi-lang-java="`value`" pulumi-lang-hcl="`value`">`value`</span> is not set. Requires Terraform version 1.11.0 or higher.
     */
    valueWo?: pulumi.Input<string | undefined>;
    /**
     * Used together with<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>to trigger an update. Increment this value when an update to the<span pulumi-lang-nodejs=" valueWo " pulumi-lang-dotnet=" ValueWo " pulumi-lang-go=" valueWo " pulumi-lang-python=" value_wo " pulumi-lang-yaml=" valueWo " pulumi-lang-java=" valueWo " pulumi-lang-hcl=" value_wo "> valueWo </span>is required.
     */
    valueWoVersion?: pulumi.Input<number | undefined>;
    /**
     * The Infisical project ID (Required for Machine Identity auth, and service tokens with multiple scopes)
     */
    workspaceId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=secret.d.ts.map