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

vault.consul.SecretBackend

Explore with Pulumi AI

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

Example Usage

Creating a standard backend resource:

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const test = new vault.consul.SecretBackend("test", {
    path: "consul",
    description: "Manages the Consul backend",
    address: "127.0.0.1:8500",
    token: "4240861b-ce3d-8530-115a-521ff070dd29",
});
Copy
import pulumi
import pulumi_vault as vault

test = vault.consul.SecretBackend("test",
    path="consul",
    description="Manages the Consul backend",
    address="127.0.0.1:8500",
    token="4240861b-ce3d-8530-115a-521ff070dd29")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := consul.NewSecretBackend(ctx, "test", &consul.SecretBackendArgs{
			Path:        pulumi.String("consul"),
			Description: pulumi.String("Manages the Consul backend"),
			Address:     pulumi.String("127.0.0.1:8500"),
			Token:       pulumi.String("4240861b-ce3d-8530-115a-521ff070dd29"),
		})
		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 test = new Vault.Consul.SecretBackend("test", new()
    {
        Path = "consul",
        Description = "Manages the Consul backend",
        Address = "127.0.0.1:8500",
        Token = "4240861b-ce3d-8530-115a-521ff070dd29",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.consul.SecretBackend;
import com.pulumi.vault.consul.SecretBackendArgs;
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 test = new SecretBackend("test", SecretBackendArgs.builder()
            .path("consul")
            .description("Manages the Consul backend")
            .address("127.0.0.1:8500")
            .token("4240861b-ce3d-8530-115a-521ff070dd29")
            .build());

    }
}
Copy
resources:
  test:
    type: vault:consul:SecretBackend
    properties:
      path: consul
      description: Manages the Consul backend
      address: 127.0.0.1:8500
      token: 4240861b-ce3d-8530-115a-521ff070dd29
Copy

Creating a backend resource to bootstrap a new Consul instance:

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const test = new vault.consul.SecretBackend("test", {
    path: "consul",
    description: "Bootstrap the Consul backend",
    address: "127.0.0.1:8500",
    bootstrap: true,
});
Copy
import pulumi
import pulumi_vault as vault

test = vault.consul.SecretBackend("test",
    path="consul",
    description="Bootstrap the Consul backend",
    address="127.0.0.1:8500",
    bootstrap=True)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := consul.NewSecretBackend(ctx, "test", &consul.SecretBackendArgs{
			Path:        pulumi.String("consul"),
			Description: pulumi.String("Bootstrap the Consul backend"),
			Address:     pulumi.String("127.0.0.1:8500"),
			Bootstrap:   pulumi.Bool(true),
		})
		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 test = new Vault.Consul.SecretBackend("test", new()
    {
        Path = "consul",
        Description = "Bootstrap the Consul backend",
        Address = "127.0.0.1:8500",
        Bootstrap = true,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.consul.SecretBackend;
import com.pulumi.vault.consul.SecretBackendArgs;
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 test = new SecretBackend("test", SecretBackendArgs.builder()
            .path("consul")
            .description("Bootstrap the Consul backend")
            .address("127.0.0.1:8500")
            .bootstrap(true)
            .build());

    }
}
Copy
resources:
  test:
    type: vault:consul:SecretBackend
    properties:
      path: consul
      description: Bootstrap the Consul backend
      address: 127.0.0.1:8500
      bootstrap: true
Copy

Create SecretBackend Resource

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

Constructor syntax

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

@overload
def SecretBackend(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  address: Optional[str] = None,
                  bootstrap: Optional[bool] = None,
                  ca_cert: Optional[str] = None,
                  client_cert: Optional[str] = None,
                  client_key: Optional[str] = None,
                  default_lease_ttl_seconds: Optional[int] = None,
                  description: Optional[str] = None,
                  disable_remount: Optional[bool] = None,
                  local: Optional[bool] = None,
                  max_lease_ttl_seconds: Optional[int] = None,
                  namespace: Optional[str] = None,
                  path: Optional[str] = None,
                  scheme: Optional[str] = None,
                  token: Optional[str] = None)
func NewSecretBackend(ctx *Context, name string, args SecretBackendArgs, opts ...ResourceOption) (*SecretBackend, error)
public SecretBackend(string name, SecretBackendArgs args, CustomResourceOptions? opts = null)
public SecretBackend(String name, SecretBackendArgs args)
public SecretBackend(String name, SecretBackendArgs args, CustomResourceOptions options)

type: vault:consul:SecretBackend
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. SecretBackendArgs
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. SecretBackendArgs
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. SecretBackendArgs
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. SecretBackendArgs
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. SecretBackendArgs
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 examplesecretBackendResourceResourceFromConsulsecretBackend = new Vault.Consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend", new()
{
    Address = "string",
    Bootstrap = false,
    CaCert = "string",
    ClientCert = "string",
    ClientKey = "string",
    DefaultLeaseTtlSeconds = 0,
    Description = "string",
    DisableRemount = false,
    Local = false,
    MaxLeaseTtlSeconds = 0,
    Namespace = "string",
    Path = "string",
    Scheme = "string",
    Token = "string",
});
Copy
example, err := consul.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromConsulsecretBackend", &consul.SecretBackendArgs{
	Address:                pulumi.String("string"),
	Bootstrap:              pulumi.Bool(false),
	CaCert:                 pulumi.String("string"),
	ClientCert:             pulumi.String("string"),
	ClientKey:              pulumi.String("string"),
	DefaultLeaseTtlSeconds: pulumi.Int(0),
	Description:            pulumi.String("string"),
	DisableRemount:         pulumi.Bool(false),
	Local:                  pulumi.Bool(false),
	MaxLeaseTtlSeconds:     pulumi.Int(0),
	Namespace:              pulumi.String("string"),
	Path:                   pulumi.String("string"),
	Scheme:                 pulumi.String("string"),
	Token:                  pulumi.String("string"),
})
Copy
var examplesecretBackendResourceResourceFromConsulsecretBackend = new SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend", SecretBackendArgs.builder()
    .address("string")
    .bootstrap(false)
    .caCert("string")
    .clientCert("string")
    .clientKey("string")
    .defaultLeaseTtlSeconds(0)
    .description("string")
    .disableRemount(false)
    .local(false)
    .maxLeaseTtlSeconds(0)
    .namespace("string")
    .path("string")
    .scheme("string")
    .token("string")
    .build());
Copy
examplesecret_backend_resource_resource_from_consulsecret_backend = vault.consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend",
    address="string",
    bootstrap=False,
    ca_cert="string",
    client_cert="string",
    client_key="string",
    default_lease_ttl_seconds=0,
    description="string",
    disable_remount=False,
    local=False,
    max_lease_ttl_seconds=0,
    namespace="string",
    path="string",
    scheme="string",
    token="string")
Copy
const examplesecretBackendResourceResourceFromConsulsecretBackend = new vault.consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend", {
    address: "string",
    bootstrap: false,
    caCert: "string",
    clientCert: "string",
    clientKey: "string",
    defaultLeaseTtlSeconds: 0,
    description: "string",
    disableRemount: false,
    local: false,
    maxLeaseTtlSeconds: 0,
    namespace: "string",
    path: "string",
    scheme: "string",
    token: "string",
});
Copy
type: vault:consul:SecretBackend
properties:
    address: string
    bootstrap: false
    caCert: string
    clientCert: string
    clientKey: string
    defaultLeaseTtlSeconds: 0
    description: string
    disableRemount: false
    local: false
    maxLeaseTtlSeconds: 0
    namespace: string
    path: string
    scheme: string
    token: string
Copy

SecretBackend 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 SecretBackend resource accepts the following input properties:

Address This property is required. string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
Bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
Local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
Specifies the Consul token to use when managing or issuing new tokens.
Address This property is required. string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
Bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
Local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
Specifies the Consul token to use when managing or issuing new tokens.
address This property is required. String
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap Boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert String
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert String
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey String
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds Integer
The default TTL for credentials issued by this backend.
description String
A human-friendly description for this backend.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. Boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds Integer
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path String
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme String
Specifies the URL scheme to use. Defaults to http.
token String
Specifies the Consul token to use when managing or issuing new tokens.
address This property is required. string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds number
The default TTL for credentials issued by this backend.
description string
A human-friendly description for this backend.
disableRemount boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds number
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme string
Specifies the URL scheme to use. Defaults to http.
token string
Specifies the Consul token to use when managing or issuing new tokens.
address This property is required. str
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
ca_cert str
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
client_cert str
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
client_key str
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
default_lease_ttl_seconds int
The default TTL for credentials issued by this backend.
description str
A human-friendly description for this backend.
disable_remount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
max_lease_ttl_seconds int
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. str
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. Available only for Vault Enterprise.
path str
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme str
Specifies the URL scheme to use. Defaults to http.
token str
Specifies the Consul token to use when managing or issuing new tokens.
address This property is required. String
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap Boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert String
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert String
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey String
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds Number
The default TTL for credentials issued by this backend.
description String
A human-friendly description for this backend.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. Boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds Number
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path String
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme String
Specifies the URL scheme to use. Defaults to http.
token String
Specifies the Consul token to use when managing or issuing new tokens.

Outputs

All input properties are implicitly available as output properties. Additionally, the SecretBackend 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 SecretBackend Resource

Get an existing SecretBackend 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?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address: Optional[str] = None,
        bootstrap: Optional[bool] = None,
        ca_cert: Optional[str] = None,
        client_cert: Optional[str] = None,
        client_key: Optional[str] = None,
        default_lease_ttl_seconds: Optional[int] = None,
        description: Optional[str] = None,
        disable_remount: Optional[bool] = None,
        local: Optional[bool] = None,
        max_lease_ttl_seconds: Optional[int] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None,
        scheme: Optional[str] = None,
        token: Optional[str] = None) -> SecretBackend
func GetSecretBackend(ctx *Context, name string, id IDInput, state *SecretBackendState, opts ...ResourceOption) (*SecretBackend, error)
public static SecretBackend Get(string name, Input<string> id, SecretBackendState? state, CustomResourceOptions? opts = null)
public static SecretBackend get(String name, Output<String> id, SecretBackendState state, CustomResourceOptions options)
resources:  _:    type: vault:consul:SecretBackend    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:
Address string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
Bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
Local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
Specifies the Consul token to use when managing or issuing new tokens.
Address string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
Bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
CaCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
ClientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
ClientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
DefaultLeaseTtlSeconds int
The default TTL for credentials issued by this backend.
Description string
A human-friendly description for this backend.
DisableRemount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
Local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
MaxLeaseTtlSeconds int
The maximum TTL that can be requested for credentials issued by this backend.
Namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
Path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
Scheme string
Specifies the URL scheme to use. Defaults to http.
Token string
Specifies the Consul token to use when managing or issuing new tokens.
address String
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap Boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert String
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert String
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey String
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds Integer
The default TTL for credentials issued by this backend.
description String
A human-friendly description for this backend.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. Boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds Integer
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path String
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme String
Specifies the URL scheme to use. Defaults to http.
token String
Specifies the Consul token to use when managing or issuing new tokens.
address string
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert string
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert string
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey string
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds number
The default TTL for credentials issued by this backend.
description string
A human-friendly description for this backend.
disableRemount boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds number
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path string
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme string
Specifies the URL scheme to use. Defaults to http.
token string
Specifies the Consul token to use when managing or issuing new tokens.
address str
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap bool
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
ca_cert str
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
client_cert str
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
client_key str
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
default_lease_ttl_seconds int
The default TTL for credentials issued by this backend.
description str
A human-friendly description for this backend.
disable_remount bool
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. bool
Specifies if the secret backend is local only.
max_lease_ttl_seconds int
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. str
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. Available only for Vault Enterprise.
path str
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme str
Specifies the URL scheme to use. Defaults to http.
token str
Specifies the Consul token to use when managing or issuing new tokens.
address String
Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
bootstrap Boolean
Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
caCert String
CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
clientCert String
Client certificate used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_key.
clientKey String
Client key used for Consul's TLS communication, must be x509 PEM encoded and if this is set you need to also set client_cert.
defaultLeaseTtlSeconds Number
The default TTL for credentials issued by this backend.
description String
A human-friendly description for this backend.
disableRemount Boolean
If set, opts out of mount migration on path updates. See here for more info on Mount Migration
local Changes to this property will trigger replacement. Boolean
Specifies if the secret backend is local only.
maxLeaseTtlSeconds Number
The maximum TTL that can be requested for credentials issued by this backend.
namespace Changes to this property will trigger replacement. 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. Available only for Vault Enterprise.
path String
The unique location this backend should be mounted at. Must not begin or end with a /. Defaults to consul.
scheme String
Specifies the URL scheme to use. Defaults to http.
token String
Specifies the Consul token to use when managing or issuing new tokens.

Import

Consul secret backends can be imported using the path, e.g.

$ pulumi import vault:consul/secretBackend:SecretBackend example consul
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