@pulumi/vault
Version:
A Pulumi package for creating and managing HashiCorp Vault cloud resources.
180 lines (179 loc) • 5.96 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vault from "@pulumi/vault";
*
* const jwt = new vault.Plugin("jwt", {
* type: "auth",
* name: "jwt",
* command: "vault-plugin-auth-jwt",
* version: "v0.17.0",
* sha256: "6bd0a803ed742aa3ce35e4fa23d2c8d550e6c1567bf63410cec489c28b68b0fc",
* envs: ["HTTP_PROXY=http://proxy.example.com:8080"],
* });
* const jwtAuth = new vault.AuthBackend("jwt_auth", {type: jwt.name});
* ```
*
* ## Import
*
* Plugins can be imported using `:type/name/:name` or `:type/version/:version/name/:name` as the ID if the version is non-empty, e.g.
*
* ```sh
* $ pulumi import vault:index/plugin:Plugin jwt auth/name/jwt
* ```
* ```sh
* $ pulumi import vault:index/plugin:Plugin jwt auth/version/v0.17.0/name/jwt
* ```
*/
export declare class Plugin extends pulumi.CustomResource {
/**
* Get an existing Plugin 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?: PluginState, opts?: pulumi.CustomResourceOptions): Plugin;
/**
* Returns true if the given object is an instance of Plugin. 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 Plugin;
/**
* List of additional args to pass to the plugin.
*/
readonly args: pulumi.Output<string[] | undefined>;
/**
* Command to execute the plugin, relative to the server's configured `pluginDirectory`.
*/
readonly command: pulumi.Output<string>;
/**
* List of additional environment variables to run the plugin with in KEY=VALUE form.
*/
readonly envs: pulumi.Output<string[] | undefined>;
/**
* Name of the plugin.
*/
readonly name: pulumi.Output<string>;
/**
* Specifies OCI image to run. If specified, setting
* `command`, `args`, and `env` will update the container's entrypoint, args, and
* environment variables (append-only) respectively.
*/
readonly ociImage: pulumi.Output<string | undefined>;
/**
* Vault plugin runtime to use if `ociImage` is specified.
*/
readonly runtime: pulumi.Output<string | undefined>;
/**
* SHA256 sum of the plugin binary.
*/
readonly sha256: pulumi.Output<string>;
/**
* Type of plugin; one of "auth", "secret", or "database".
*/
readonly type: pulumi.Output<string>;
/**
* Semantic version of the plugin.
*/
readonly version: pulumi.Output<string | undefined>;
/**
* Create a Plugin 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: PluginArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Plugin resources.
*/
export interface PluginState {
/**
* List of additional args to pass to the plugin.
*/
args?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Command to execute the plugin, relative to the server's configured `pluginDirectory`.
*/
command?: pulumi.Input<string>;
/**
* List of additional environment variables to run the plugin with in KEY=VALUE form.
*/
envs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the plugin.
*/
name?: pulumi.Input<string>;
/**
* Specifies OCI image to run. If specified, setting
* `command`, `args`, and `env` will update the container's entrypoint, args, and
* environment variables (append-only) respectively.
*/
ociImage?: pulumi.Input<string>;
/**
* Vault plugin runtime to use if `ociImage` is specified.
*/
runtime?: pulumi.Input<string>;
/**
* SHA256 sum of the plugin binary.
*/
sha256?: pulumi.Input<string>;
/**
* Type of plugin; one of "auth", "secret", or "database".
*/
type?: pulumi.Input<string>;
/**
* Semantic version of the plugin.
*/
version?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Plugin resource.
*/
export interface PluginArgs {
/**
* List of additional args to pass to the plugin.
*/
args?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Command to execute the plugin, relative to the server's configured `pluginDirectory`.
*/
command: pulumi.Input<string>;
/**
* List of additional environment variables to run the plugin with in KEY=VALUE form.
*/
envs?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of the plugin.
*/
name?: pulumi.Input<string>;
/**
* Specifies OCI image to run. If specified, setting
* `command`, `args`, and `env` will update the container's entrypoint, args, and
* environment variables (append-only) respectively.
*/
ociImage?: pulumi.Input<string>;
/**
* Vault plugin runtime to use if `ociImage` is specified.
*/
runtime?: pulumi.Input<string>;
/**
* SHA256 sum of the plugin binary.
*/
sha256: pulumi.Input<string>;
/**
* Type of plugin; one of "auth", "secret", or "database".
*/
type: pulumi.Input<string>;
/**
* Semantic version of the plugin.
*/
version?: pulumi.Input<string>;
}