vault.consul.SecretBackend
Explore with Pulumi AI
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",
});
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")
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/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
})
}
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",
});
});
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());
}
}
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
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,
});
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)
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/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
})
}
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,
});
});
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());
}
}
resources:
test:
type: vault:consul:SecretBackend
properties:
path: consul
description: Bootstrap the Consul backend
address: 127.0.0.1:8500
bootstrap: true
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,
allowed_managed_keys: Optional[Sequence[str]] = None,
allowed_response_headers: Optional[Sequence[str]] = None,
audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
audit_non_hmac_response_keys: Optional[Sequence[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,
delegated_auth_accessors: Optional[Sequence[str]] = None,
description: Optional[str] = None,
disable_remount: Optional[bool] = None,
external_entropy_access: Optional[bool] = None,
force_no_cache: Optional[bool] = None,
identity_token_key: Optional[str] = None,
listing_visibility: Optional[str] = None,
local: Optional[bool] = None,
max_lease_ttl_seconds: Optional[int] = None,
namespace: Optional[str] = None,
options: Optional[Mapping[str, str]] = None,
passthrough_request_headers: Optional[Sequence[str]] = None,
path: Optional[str] = None,
plugin_version: Optional[str] = None,
scheme: Optional[str] = None,
seal_wrap: Optional[bool] = 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 string
- The unique name of the resource.
- args SecretBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args SecretBackendArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SecretBackendArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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",
AllowedManagedKeys = new[]
{
"string",
},
AllowedResponseHeaders = new[]
{
"string",
},
AuditNonHmacRequestKeys = new[]
{
"string",
},
AuditNonHmacResponseKeys = new[]
{
"string",
},
Bootstrap = false,
CaCert = "string",
ClientCert = "string",
ClientKey = "string",
DefaultLeaseTtlSeconds = 0,
DelegatedAuthAccessors = new[]
{
"string",
},
Description = "string",
DisableRemount = false,
ExternalEntropyAccess = false,
ForceNoCache = false,
IdentityTokenKey = "string",
ListingVisibility = "string",
Local = false,
MaxLeaseTtlSeconds = 0,
Namespace = "string",
Options =
{
{ "string", "string" },
},
PassthroughRequestHeaders = new[]
{
"string",
},
Path = "string",
PluginVersion = "string",
Scheme = "string",
SealWrap = false,
Token = "string",
});
example, err := consul.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromConsulsecretBackend", &consul.SecretBackendArgs{
Address: pulumi.String("string"),
AllowedManagedKeys: pulumi.StringArray{
pulumi.String("string"),
},
AllowedResponseHeaders: pulumi.StringArray{
pulumi.String("string"),
},
AuditNonHmacRequestKeys: pulumi.StringArray{
pulumi.String("string"),
},
AuditNonHmacResponseKeys: pulumi.StringArray{
pulumi.String("string"),
},
Bootstrap: pulumi.Bool(false),
CaCert: pulumi.String("string"),
ClientCert: pulumi.String("string"),
ClientKey: pulumi.String("string"),
DefaultLeaseTtlSeconds: pulumi.Int(0),
DelegatedAuthAccessors: pulumi.StringArray{
pulumi.String("string"),
},
Description: pulumi.String("string"),
DisableRemount: pulumi.Bool(false),
ExternalEntropyAccess: pulumi.Bool(false),
ForceNoCache: pulumi.Bool(false),
IdentityTokenKey: pulumi.String("string"),
ListingVisibility: pulumi.String("string"),
Local: pulumi.Bool(false),
MaxLeaseTtlSeconds: pulumi.Int(0),
Namespace: pulumi.String("string"),
Options: pulumi.StringMap{
"string": pulumi.String("string"),
},
PassthroughRequestHeaders: pulumi.StringArray{
pulumi.String("string"),
},
Path: pulumi.String("string"),
PluginVersion: pulumi.String("string"),
Scheme: pulumi.String("string"),
SealWrap: pulumi.Bool(false),
Token: pulumi.String("string"),
})
var examplesecretBackendResourceResourceFromConsulsecretBackend = new com.pulumi.vault.consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend", com.pulumi.vault.consul.SecretBackendArgs.builder()
.address("string")
.allowedManagedKeys("string")
.allowedResponseHeaders("string")
.auditNonHmacRequestKeys("string")
.auditNonHmacResponseKeys("string")
.bootstrap(false)
.caCert("string")
.clientCert("string")
.clientKey("string")
.defaultLeaseTtlSeconds(0)
.delegatedAuthAccessors("string")
.description("string")
.disableRemount(false)
.externalEntropyAccess(false)
.forceNoCache(false)
.identityTokenKey("string")
.listingVisibility("string")
.local(false)
.maxLeaseTtlSeconds(0)
.namespace("string")
.options(Map.of("string", "string"))
.passthroughRequestHeaders("string")
.path("string")
.pluginVersion("string")
.scheme("string")
.sealWrap(false)
.token("string")
.build());
examplesecret_backend_resource_resource_from_consulsecret_backend = vault.consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend",
address="string",
allowed_managed_keys=["string"],
allowed_response_headers=["string"],
audit_non_hmac_request_keys=["string"],
audit_non_hmac_response_keys=["string"],
bootstrap=False,
ca_cert="string",
client_cert="string",
client_key="string",
default_lease_ttl_seconds=0,
delegated_auth_accessors=["string"],
description="string",
disable_remount=False,
external_entropy_access=False,
force_no_cache=False,
identity_token_key="string",
listing_visibility="string",
local=False,
max_lease_ttl_seconds=0,
namespace="string",
options={
"string": "string",
},
passthrough_request_headers=["string"],
path="string",
plugin_version="string",
scheme="string",
seal_wrap=False,
token="string")
const examplesecretBackendResourceResourceFromConsulsecretBackend = new vault.consul.SecretBackend("examplesecretBackendResourceResourceFromConsulsecretBackend", {
address: "string",
allowedManagedKeys: ["string"],
allowedResponseHeaders: ["string"],
auditNonHmacRequestKeys: ["string"],
auditNonHmacResponseKeys: ["string"],
bootstrap: false,
caCert: "string",
clientCert: "string",
clientKey: "string",
defaultLeaseTtlSeconds: 0,
delegatedAuthAccessors: ["string"],
description: "string",
disableRemount: false,
externalEntropyAccess: false,
forceNoCache: false,
identityTokenKey: "string",
listingVisibility: "string",
local: false,
maxLeaseTtlSeconds: 0,
namespace: "string",
options: {
string: "string",
},
passthroughRequestHeaders: ["string"],
path: "string",
pluginVersion: "string",
scheme: "string",
sealWrap: false,
token: "string",
});
type: vault:consul:SecretBackend
properties:
address: string
allowedManagedKeys:
- string
allowedResponseHeaders:
- string
auditNonHmacRequestKeys:
- string
auditNonHmacResponseKeys:
- string
bootstrap: false
caCert: string
clientCert: string
clientKey: string
defaultLeaseTtlSeconds: 0
delegatedAuthAccessors:
- string
description: string
disableRemount: false
externalEntropyAccess: false
forceNoCache: false
identityTokenKey: string
listingVisibility: string
local: false
maxLeaseTtlSeconds: 0
namespace: string
options:
string: string
passthroughRequestHeaders:
- string
path: string
pluginVersion: string
scheme: string
sealWrap: false
token: string
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 string
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- Allowed
Managed List<string>Keys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response List<string>Headers - List of headers to allow and pass from the request to the plugin
- Audit
Non List<string>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non List<string>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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 string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- Client
Cert 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.
- Client
Key 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.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth List<string>Accessors - List of headers to allow and pass from the request to the plugin
- Description string
- 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
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Specifies if the secret backend is local only
- Max
Lease intTtl Seconds - Maximum possible lease duration for secrets in seconds
- Namespace 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. - Options Dictionary<string, string>
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Scheme string
- Specifies the URL scheme to use. Defaults to
http
. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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".
- Allowed
Managed []stringKeys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response []stringHeaders - List of headers to allow and pass from the request to the plugin
- Audit
Non []stringHmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non []stringHmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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 string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- Client
Cert 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.
- Client
Key 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.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth []stringAccessors - List of headers to allow and pass from the request to the plugin
- Description string
- 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
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Specifies if the secret backend is local only
- Max
Lease intTtl Seconds - Maximum possible lease duration for secrets in seconds
- Namespace 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. - Options map[string]string
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Scheme string
- Specifies the URL scheme to use. Defaults to
http
. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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".
- allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap Boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert String - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease IntegerTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- A human-friendly description for this backend.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Specifies if the secret backend is local only
- max
Lease IntegerTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Map<String,String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme String
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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".
- allowed
Managed string[]Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response string[]Headers - List of headers to allow and pass from the request to the plugin
- audit
Non string[]Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non string[]Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease numberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth string[]Accessors - List of headers to allow and pass from the request to the plugin
- description string
- A human-friendly description for this backend.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Specifies if the secret backend is local only
- max
Lease numberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options {[key: string]: string}
- Specifies mount type specific options that are passed to the backend
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme string
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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".
- allowed_
managed_ Sequence[str]keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed_
response_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- audit_
non_ Sequence[str]hmac_ request_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit_
non_ Sequence[str]hmac_ response_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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_ intttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ Sequence[str]accessors - List of headers to allow and pass from the request to the plugin
- 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
- external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ strkey - The key to use for signing plugin workload identity tokens
- listing_
visibility str - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Specifies if the secret backend is local only
- max_
lease_ intttl_ seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Mapping[str, str]
- Specifies mount type specific options that are passed to the backend
- passthrough_
request_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- path str
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin_
version str - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme str
- Specifies the URL scheme to use. Defaults to
http
. - seal_
wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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".
- allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap Boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert String - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease NumberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- A human-friendly description for this backend.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Specifies if the secret backend is local only
- max
Lease NumberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Map<String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme String
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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:
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,
accessor: Optional[str] = None,
address: Optional[str] = None,
allowed_managed_keys: Optional[Sequence[str]] = None,
allowed_response_headers: Optional[Sequence[str]] = None,
audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
audit_non_hmac_response_keys: Optional[Sequence[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,
delegated_auth_accessors: Optional[Sequence[str]] = None,
description: Optional[str] = None,
disable_remount: Optional[bool] = None,
external_entropy_access: Optional[bool] = None,
force_no_cache: Optional[bool] = None,
identity_token_key: Optional[str] = None,
listing_visibility: Optional[str] = None,
local: Optional[bool] = None,
max_lease_ttl_seconds: Optional[int] = None,
namespace: Optional[str] = None,
options: Optional[Mapping[str, str]] = None,
passthrough_request_headers: Optional[Sequence[str]] = None,
path: Optional[str] = None,
plugin_version: Optional[str] = None,
scheme: Optional[str] = None,
seal_wrap: Optional[bool] = 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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
- The unique name of the resulting resource.
- id
- 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.
- Accessor string
- Accessor of the mount
- Address string
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- Allowed
Managed List<string>Keys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response List<string>Headers - List of headers to allow and pass from the request to the plugin
- Audit
Non List<string>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non List<string>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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 string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- Client
Cert 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.
- Client
Key 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.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth List<string>Accessors - List of headers to allow and pass from the request to the plugin
- Description string
- 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
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Specifies if the secret backend is local only
- Max
Lease intTtl Seconds - Maximum possible lease duration for secrets in seconds
- Namespace 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. - Options Dictionary<string, string>
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Scheme string
- Specifies the URL scheme to use. Defaults to
http
. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Token string
- Specifies the Consul token to use when managing or issuing new tokens.
- Accessor string
- Accessor of the mount
- Address string
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- Allowed
Managed []stringKeys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response []stringHeaders - List of headers to allow and pass from the request to the plugin
- Audit
Non []stringHmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non []stringHmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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 string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- Client
Cert 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.
- Client
Key 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.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth []stringAccessors - List of headers to allow and pass from the request to the plugin
- Description string
- 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
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Specifies if the secret backend is local only
- Max
Lease intTtl Seconds - Maximum possible lease duration for secrets in seconds
- Namespace 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. - Options map[string]string
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Scheme string
- Specifies the URL scheme to use. Defaults to
http
. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Token string
- Specifies the Consul token to use when managing or issuing new tokens.
- accessor String
- Accessor of the mount
- address String
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap Boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert String - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease IntegerTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- A human-friendly description for this backend.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Specifies if the secret backend is local only
- max
Lease IntegerTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Map<String,String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme String
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token String
- Specifies the Consul token to use when managing or issuing new tokens.
- accessor string
- Accessor of the mount
- address string
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- allowed
Managed string[]Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response string[]Headers - List of headers to allow and pass from the request to the plugin
- audit
Non string[]Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non string[]Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert string - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease numberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth string[]Accessors - List of headers to allow and pass from the request to the plugin
- description string
- A human-friendly description for this backend.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Specifies if the secret backend is local only
- max
Lease numberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options {[key: string]: string}
- Specifies mount type specific options that are passed to the backend
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- path string
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme string
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token string
- Specifies the Consul token to use when managing or issuing new tokens.
- accessor str
- Accessor of the mount
- address str
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- allowed_
managed_ Sequence[str]keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed_
response_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- audit_
non_ Sequence[str]hmac_ request_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit_
non_ Sequence[str]hmac_ response_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- 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_ intttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ Sequence[str]accessors - List of headers to allow and pass from the request to the plugin
- 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
- external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ strkey - The key to use for signing plugin workload identity tokens
- listing_
visibility str - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Specifies if the secret backend is local only
- max_
lease_ intttl_ seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Mapping[str, str]
- Specifies mount type specific options that are passed to the backend
- passthrough_
request_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- path str
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin_
version str - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme str
- Specifies the URL scheme to use. Defaults to
http
. - seal_
wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token str
- Specifies the Consul token to use when managing or issuing new tokens.
- accessor String
- Accessor of the mount
- address String
- Specifies the address of the Consul instance, provided as "host:port" like "127.0.0.1:8500".
- allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- bootstrap Boolean
- Denotes a backend resource that is used to bootstrap the Consul ACL system. Only one resource may be used to bootstrap.
- ca
Cert String - CA certificate to use when verifying Consul server certificate, must be x509 PEM encoded.
- client
Cert 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.
- client
Key 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.
- default
Lease NumberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- A human-friendly description for this backend.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Specifies if the secret backend is local only
- max
Lease NumberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace 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. - options Map<String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique location this backend should be mounted at. Must not begin or end with a
/
. Defaults toconsul
. - plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- scheme String
- Specifies the URL scheme to use. Defaults to
http
. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- 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
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.