Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. Plugin
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

vault.Plugin

Explore with Pulumi AI

HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault

Example Usage

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});
Copy
import pulumi
import pulumi_vault as vault

jwt = 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"])
jwt_auth = vault.AuthBackend("jwt_auth", type=jwt.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		jwt, err := vault.NewPlugin(ctx, "jwt", &vault.PluginArgs{
			Type:    pulumi.String("auth"),
			Name:    pulumi.String("jwt"),
			Command: pulumi.String("vault-plugin-auth-jwt"),
			Version: pulumi.String("v0.17.0"),
			Sha256:  pulumi.String("6bd0a803ed742aa3ce35e4fa23d2c8d550e6c1567bf63410cec489c28b68b0fc"),
			Envs: pulumi.StringArray{
				pulumi.String("HTTP_PROXY=http://proxy.example.com:8080"),
			},
		})
		if err != nil {
			return err
		}
		_, err = vault.NewAuthBackend(ctx, "jwt_auth", &vault.AuthBackendArgs{
			Type: jwt.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;

return await Deployment.RunAsync(() => 
{
    var jwt = new Vault.Plugin("jwt", new()
    {
        Type = "auth",
        Name = "jwt",
        Command = "vault-plugin-auth-jwt",
        Version = "v0.17.0",
        Sha256 = "6bd0a803ed742aa3ce35e4fa23d2c8d550e6c1567bf63410cec489c28b68b0fc",
        Envs = new[]
        {
            "HTTP_PROXY=http://proxy.example.com:8080",
        },
    });

    var jwtAuth = new Vault.AuthBackend("jwt_auth", new()
    {
        Type = jwt.Name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.Plugin;
import com.pulumi.vault.PluginArgs;
import com.pulumi.vault.AuthBackend;
import com.pulumi.vault.AuthBackendArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var jwt = new Plugin("jwt", PluginArgs.builder()
            .type("auth")
            .name("jwt")
            .command("vault-plugin-auth-jwt")
            .version("v0.17.0")
            .sha256("6bd0a803ed742aa3ce35e4fa23d2c8d550e6c1567bf63410cec489c28b68b0fc")
            .envs("HTTP_PROXY=http://proxy.example.com:8080")
            .build());

        var jwtAuth = new AuthBackend("jwtAuth", AuthBackendArgs.builder()
            .type(jwt.name())
            .build());

    }
}
Copy
resources:
  jwt:
    type: vault:Plugin
    properties:
      type: auth
      name: jwt
      command: vault-plugin-auth-jwt
      version: v0.17.0
      sha256: 6bd0a803ed742aa3ce35e4fa23d2c8d550e6c1567bf63410cec489c28b68b0fc
      envs:
        - HTTP_PROXY=http://proxy.example.com:8080
  jwtAuth:
    type: vault:AuthBackend
    name: jwt_auth
    properties:
      type: ${jwt.name}
Copy

Create Plugin Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Plugin(name: string, args: PluginArgs, opts?: CustomResourceOptions);
@overload
def Plugin(resource_name: str,
           args: PluginArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Plugin(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           command: Optional[str] = None,
           sha256: Optional[str] = None,
           type: Optional[str] = None,
           args: Optional[Sequence[str]] = None,
           envs: Optional[Sequence[str]] = None,
           name: Optional[str] = None,
           oci_image: Optional[str] = None,
           runtime: Optional[str] = None,
           version: Optional[str] = None)
func NewPlugin(ctx *Context, name string, args PluginArgs, opts ...ResourceOption) (*Plugin, error)
public Plugin(string name, PluginArgs args, CustomResourceOptions? opts = null)
public Plugin(String name, PluginArgs args)
public Plugin(String name, PluginArgs args, CustomResourceOptions options)

type: vault:Plugin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. PluginArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. PluginArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. PluginArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. PluginArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. PluginArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var pluginResource = new Vault.Plugin("pluginResource", new()
{
    Command = "string",
    Sha256 = "string",
    Type = "string",
    Args = new[]
    {
        "string",
    },
    Envs = new[]
    {
        "string",
    },
    Name = "string",
    OciImage = "string",
    Runtime = "string",
    Version = "string",
});
Copy
example, err := vault.NewPlugin(ctx, "pluginResource", &vault.PluginArgs{
	Command: pulumi.String("string"),
	Sha256:  pulumi.String("string"),
	Type:    pulumi.String("string"),
	Args: pulumi.StringArray{
		pulumi.String("string"),
	},
	Envs: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:     pulumi.String("string"),
	OciImage: pulumi.String("string"),
	Runtime:  pulumi.String("string"),
	Version:  pulumi.String("string"),
})
Copy
var pluginResource = new Plugin("pluginResource", PluginArgs.builder()
    .command("string")
    .sha256("string")
    .type("string")
    .args("string")
    .envs("string")
    .name("string")
    .ociImage("string")
    .runtime("string")
    .version("string")
    .build());
Copy
plugin_resource = vault.Plugin("pluginResource",
    command="string",
    sha256="string",
    type="string",
    args=["string"],
    envs=["string"],
    name="string",
    oci_image="string",
    runtime="string",
    version="string")
Copy
const pluginResource = new vault.Plugin("pluginResource", {
    command: "string",
    sha256: "string",
    type: "string",
    args: ["string"],
    envs: ["string"],
    name: "string",
    ociImage: "string",
    runtime: "string",
    version: "string",
});
Copy
type: vault:Plugin
properties:
    args:
        - string
    command: string
    envs:
        - string
    name: string
    ociImage: string
    runtime: string
    sha256: string
    type: string
    version: string
Copy

Plugin Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Plugin resource accepts the following input properties:

Command This property is required. string
Command to execute the plugin, relative to the server's configured plugin_directory.
Sha256 This property is required. string
SHA256 sum of the plugin binary.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of plugin; one of "auth", "secret", or "database".
Args List<string>
List of additional args to pass to the plugin.
Envs List<string>
List of additional environment variables to run the plugin with in KEY=VALUE form.
Name Changes to this property will trigger replacement. string
Name of the plugin.
OciImage 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.
Runtime string
Vault plugin runtime to use if oci_image is specified.
Version Changes to this property will trigger replacement. string
Semantic version of the plugin.
Command This property is required. string
Command to execute the plugin, relative to the server's configured plugin_directory.
Sha256 This property is required. string
SHA256 sum of the plugin binary.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of plugin; one of "auth", "secret", or "database".
Args []string
List of additional args to pass to the plugin.
Envs []string
List of additional environment variables to run the plugin with in KEY=VALUE form.
Name Changes to this property will trigger replacement. string
Name of the plugin.
OciImage 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.
Runtime string
Vault plugin runtime to use if oci_image is specified.
Version Changes to this property will trigger replacement. string
Semantic version of the plugin.
command This property is required. String
Command to execute the plugin, relative to the server's configured plugin_directory.
sha256 This property is required. String
SHA256 sum of the plugin binary.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of plugin; one of "auth", "secret", or "database".
args List<String>
List of additional args to pass to the plugin.
envs List<String>
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. String
Name of the plugin.
ociImage 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.
runtime String
Vault plugin runtime to use if oci_image is specified.
version Changes to this property will trigger replacement. String
Semantic version of the plugin.
command This property is required. string
Command to execute the plugin, relative to the server's configured plugin_directory.
sha256 This property is required. string
SHA256 sum of the plugin binary.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of plugin; one of "auth", "secret", or "database".
args string[]
List of additional args to pass to the plugin.
envs string[]
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. string
Name of the plugin.
ociImage 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.
runtime string
Vault plugin runtime to use if oci_image is specified.
version Changes to this property will trigger replacement. string
Semantic version of the plugin.
command This property is required. str
Command to execute the plugin, relative to the server's configured plugin_directory.
sha256 This property is required. str
SHA256 sum of the plugin binary.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of plugin; one of "auth", "secret", or "database".
args Sequence[str]
List of additional args to pass to the plugin.
envs Sequence[str]
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. str
Name of the plugin.
oci_image str
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.
runtime str
Vault plugin runtime to use if oci_image is specified.
version Changes to this property will trigger replacement. str
Semantic version of the plugin.
command This property is required. String
Command to execute the plugin, relative to the server's configured plugin_directory.
sha256 This property is required. String
SHA256 sum of the plugin binary.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of plugin; one of "auth", "secret", or "database".
args List<String>
List of additional args to pass to the plugin.
envs List<String>
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. String
Name of the plugin.
ociImage 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.
runtime String
Vault plugin runtime to use if oci_image is specified.
version Changes to this property will trigger replacement. String
Semantic version of the plugin.

Outputs

All input properties are implicitly available as output properties. Additionally, the Plugin resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Plugin Resource

Get an existing Plugin resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: PluginState, opts?: CustomResourceOptions): Plugin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        args: Optional[Sequence[str]] = None,
        command: Optional[str] = None,
        envs: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        oci_image: Optional[str] = None,
        runtime: Optional[str] = None,
        sha256: Optional[str] = None,
        type: Optional[str] = None,
        version: Optional[str] = None) -> Plugin
func GetPlugin(ctx *Context, name string, id IDInput, state *PluginState, opts ...ResourceOption) (*Plugin, error)
public static Plugin Get(string name, Input<string> id, PluginState? state, CustomResourceOptions? opts = null)
public static Plugin get(String name, Output<String> id, PluginState state, CustomResourceOptions options)
resources:  _:    type: vault:Plugin    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Args List<string>
List of additional args to pass to the plugin.
Command string
Command to execute the plugin, relative to the server's configured plugin_directory.
Envs List<string>
List of additional environment variables to run the plugin with in KEY=VALUE form.
Name Changes to this property will trigger replacement. string
Name of the plugin.
OciImage 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.
Runtime string
Vault plugin runtime to use if oci_image is specified.
Sha256 string
SHA256 sum of the plugin binary.
Type Changes to this property will trigger replacement. string
Type of plugin; one of "auth", "secret", or "database".
Version Changes to this property will trigger replacement. string
Semantic version of the plugin.
Args []string
List of additional args to pass to the plugin.
Command string
Command to execute the plugin, relative to the server's configured plugin_directory.
Envs []string
List of additional environment variables to run the plugin with in KEY=VALUE form.
Name Changes to this property will trigger replacement. string
Name of the plugin.
OciImage 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.
Runtime string
Vault plugin runtime to use if oci_image is specified.
Sha256 string
SHA256 sum of the plugin binary.
Type Changes to this property will trigger replacement. string
Type of plugin; one of "auth", "secret", or "database".
Version Changes to this property will trigger replacement. string
Semantic version of the plugin.
args List<String>
List of additional args to pass to the plugin.
command String
Command to execute the plugin, relative to the server's configured plugin_directory.
envs List<String>
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. String
Name of the plugin.
ociImage 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.
runtime String
Vault plugin runtime to use if oci_image is specified.
sha256 String
SHA256 sum of the plugin binary.
type Changes to this property will trigger replacement. String
Type of plugin; one of "auth", "secret", or "database".
version Changes to this property will trigger replacement. String
Semantic version of the plugin.
args string[]
List of additional args to pass to the plugin.
command string
Command to execute the plugin, relative to the server's configured plugin_directory.
envs string[]
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. string
Name of the plugin.
ociImage 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.
runtime string
Vault plugin runtime to use if oci_image is specified.
sha256 string
SHA256 sum of the plugin binary.
type Changes to this property will trigger replacement. string
Type of plugin; one of "auth", "secret", or "database".
version Changes to this property will trigger replacement. string
Semantic version of the plugin.
args Sequence[str]
List of additional args to pass to the plugin.
command str
Command to execute the plugin, relative to the server's configured plugin_directory.
envs Sequence[str]
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. str
Name of the plugin.
oci_image str
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.
runtime str
Vault plugin runtime to use if oci_image is specified.
sha256 str
SHA256 sum of the plugin binary.
type Changes to this property will trigger replacement. str
Type of plugin; one of "auth", "secret", or "database".
version Changes to this property will trigger replacement. str
Semantic version of the plugin.
args List<String>
List of additional args to pass to the plugin.
command String
Command to execute the plugin, relative to the server's configured plugin_directory.
envs List<String>
List of additional environment variables to run the plugin with in KEY=VALUE form.
name Changes to this property will trigger replacement. String
Name of the plugin.
ociImage 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.
runtime String
Vault plugin runtime to use if oci_image is specified.
sha256 String
SHA256 sum of the plugin binary.
type Changes to this property will trigger replacement. String
Type of plugin; one of "auth", "secret", or "database".
version Changes to this property will trigger replacement. String
Semantic version of the plugin.

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.

$ pulumi import vault:index/plugin:Plugin jwt auth/name/jwt
Copy
$ pulumi import vault:index/plugin:Plugin jwt auth/version/v0.17.0/name/jwt
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Vault pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.
HashiCorp Vault v6.6.0 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-vault