vault.kubernetes.SecretBackend
Explore with Pulumi AI
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as std from "@pulumi/std";
import * as vault from "@pulumi/vault";
const config = new vault.kubernetes.SecretBackend("config", {
    path: "kubernetes",
    description: "kubernetes secrets engine description",
    defaultLeaseTtlSeconds: 43200,
    maxLeaseTtlSeconds: 86400,
    kubernetesHost: "https://127.0.0.1:61233",
    kubernetesCaCert: std.file({
        input: "/path/to/cert",
    }).then(invoke => invoke.result),
    serviceAccountJwt: std.file({
        input: "/path/to/token",
    }).then(invoke => invoke.result),
    disableLocalCaJwt: false,
});
import pulumi
import pulumi_std as std
import pulumi_vault as vault
config = vault.kubernetes.SecretBackend("config",
    path="kubernetes",
    description="kubernetes secrets engine description",
    default_lease_ttl_seconds=43200,
    max_lease_ttl_seconds=86400,
    kubernetes_host="https://127.0.0.1:61233",
    kubernetes_ca_cert=std.file(input="/path/to/cert").result,
    service_account_jwt=std.file(input="/path/to/token").result,
    disable_local_ca_jwt=False)
package main
import (
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/kubernetes"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "/path/to/cert",
		}, nil)
		if err != nil {
			return err
		}
		invokeFile1, err := std.File(ctx, &std.FileArgs{
			Input: "/path/to/token",
		}, nil)
		if err != nil {
			return err
		}
		_, err = kubernetes.NewSecretBackend(ctx, "config", &kubernetes.SecretBackendArgs{
			Path:                   pulumi.String("kubernetes"),
			Description:            pulumi.String("kubernetes secrets engine description"),
			DefaultLeaseTtlSeconds: pulumi.Int(43200),
			MaxLeaseTtlSeconds:     pulumi.Int(86400),
			KubernetesHost:         pulumi.String("https://127.0.0.1:61233"),
			KubernetesCaCert:       pulumi.String(invokeFile.Result),
			ServiceAccountJwt:      pulumi.String(invokeFile1.Result),
			DisableLocalCaJwt:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Std = Pulumi.Std;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() => 
{
    var config = new Vault.Kubernetes.SecretBackend("config", new()
    {
        Path = "kubernetes",
        Description = "kubernetes secrets engine description",
        DefaultLeaseTtlSeconds = 43200,
        MaxLeaseTtlSeconds = 86400,
        KubernetesHost = "https://127.0.0.1:61233",
        KubernetesCaCert = Std.File.Invoke(new()
        {
            Input = "/path/to/cert",
        }).Apply(invoke => invoke.Result),
        ServiceAccountJwt = Std.File.Invoke(new()
        {
            Input = "/path/to/token",
        }).Apply(invoke => invoke.Result),
        DisableLocalCaJwt = false,
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.kubernetes.SecretBackend;
import com.pulumi.vault.kubernetes.SecretBackendArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
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 config = new SecretBackend("config", SecretBackendArgs.builder()
            .path("kubernetes")
            .description("kubernetes secrets engine description")
            .defaultLeaseTtlSeconds(43200)
            .maxLeaseTtlSeconds(86400)
            .kubernetesHost("https://127.0.0.1:61233")
            .kubernetesCaCert(StdFunctions.file(FileArgs.builder()
                .input("/path/to/cert")
                .build()).result())
            .serviceAccountJwt(StdFunctions.file(FileArgs.builder()
                .input("/path/to/token")
                .build()).result())
            .disableLocalCaJwt(false)
            .build());
    }
}
resources:
  config:
    type: vault:kubernetes:SecretBackend
    properties:
      path: kubernetes
      description: kubernetes secrets engine description
      defaultLeaseTtlSeconds: 43200
      maxLeaseTtlSeconds: 86400
      kubernetesHost: https://127.0.0.1:61233
      kubernetesCaCert:
        fn::invoke:
          function: std:file
          arguments:
            input: /path/to/cert
          return: result
      serviceAccountJwt:
        fn::invoke:
          function: std:file
          arguments:
            input: /path/to/token
          return: result
      disableLocalCaJwt: false
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,
                  path: Optional[str] = None,
                  kubernetes_ca_cert: Optional[str] = None,
                  listing_visibility: Optional[str] = None,
                  audit_non_hmac_response_keys: Optional[Sequence[str]] = None,
                  default_lease_ttl_seconds: Optional[int] = None,
                  delegated_auth_accessors: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  disable_local_ca_jwt: Optional[bool] = None,
                  external_entropy_access: Optional[bool] = None,
                  identity_token_key: Optional[str] = None,
                  allowed_managed_keys: Optional[Sequence[str]] = None,
                  audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
                  local: Optional[bool] = None,
                  kubernetes_host: Optional[str] = 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,
                  allowed_response_headers: Optional[Sequence[str]] = None,
                  plugin_version: Optional[str] = None,
                  seal_wrap: Optional[bool] = None,
                  service_account_jwt: 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:kubernetes: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 examplesecretBackendResourceResourceFromKubernetessecretBackend = new Vault.Kubernetes.SecretBackend("examplesecretBackendResourceResourceFromKubernetessecretBackend", new()
{
    Path = "string",
    KubernetesCaCert = "string",
    ListingVisibility = "string",
    AuditNonHmacResponseKeys = new[]
    {
        "string",
    },
    DefaultLeaseTtlSeconds = 0,
    DelegatedAuthAccessors = new[]
    {
        "string",
    },
    Description = "string",
    DisableLocalCaJwt = false,
    ExternalEntropyAccess = false,
    IdentityTokenKey = "string",
    AllowedManagedKeys = new[]
    {
        "string",
    },
    AuditNonHmacRequestKeys = new[]
    {
        "string",
    },
    Local = false,
    KubernetesHost = "string",
    MaxLeaseTtlSeconds = 0,
    Namespace = "string",
    Options = 
    {
        { "string", "string" },
    },
    PassthroughRequestHeaders = new[]
    {
        "string",
    },
    AllowedResponseHeaders = new[]
    {
        "string",
    },
    PluginVersion = "string",
    SealWrap = false,
    ServiceAccountJwt = "string",
});
example, err := kubernetes.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromKubernetessecretBackend", &kubernetes.SecretBackendArgs{
	Path:              pulumi.String("string"),
	KubernetesCaCert:  pulumi.String("string"),
	ListingVisibility: pulumi.String("string"),
	AuditNonHmacResponseKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	DefaultLeaseTtlSeconds: pulumi.Int(0),
	DelegatedAuthAccessors: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:           pulumi.String("string"),
	DisableLocalCaJwt:     pulumi.Bool(false),
	ExternalEntropyAccess: pulumi.Bool(false),
	IdentityTokenKey:      pulumi.String("string"),
	AllowedManagedKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuditNonHmacRequestKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
	Local:              pulumi.Bool(false),
	KubernetesHost:     pulumi.String("string"),
	MaxLeaseTtlSeconds: pulumi.Int(0),
	Namespace:          pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PassthroughRequestHeaders: pulumi.StringArray{
		pulumi.String("string"),
	},
	AllowedResponseHeaders: pulumi.StringArray{
		pulumi.String("string"),
	},
	PluginVersion:     pulumi.String("string"),
	SealWrap:          pulumi.Bool(false),
	ServiceAccountJwt: pulumi.String("string"),
})
var examplesecretBackendResourceResourceFromKubernetessecretBackend = new com.pulumi.vault.kubernetes.SecretBackend("examplesecretBackendResourceResourceFromKubernetessecretBackend", com.pulumi.vault.kubernetes.SecretBackendArgs.builder()
    .path("string")
    .kubernetesCaCert("string")
    .listingVisibility("string")
    .auditNonHmacResponseKeys("string")
    .defaultLeaseTtlSeconds(0)
    .delegatedAuthAccessors("string")
    .description("string")
    .disableLocalCaJwt(false)
    .externalEntropyAccess(false)
    .identityTokenKey("string")
    .allowedManagedKeys("string")
    .auditNonHmacRequestKeys("string")
    .local(false)
    .kubernetesHost("string")
    .maxLeaseTtlSeconds(0)
    .namespace("string")
    .options(Map.of("string", "string"))
    .passthroughRequestHeaders("string")
    .allowedResponseHeaders("string")
    .pluginVersion("string")
    .sealWrap(false)
    .serviceAccountJwt("string")
    .build());
examplesecret_backend_resource_resource_from_kubernetessecret_backend = vault.kubernetes.SecretBackend("examplesecretBackendResourceResourceFromKubernetessecretBackend",
    path="string",
    kubernetes_ca_cert="string",
    listing_visibility="string",
    audit_non_hmac_response_keys=["string"],
    default_lease_ttl_seconds=0,
    delegated_auth_accessors=["string"],
    description="string",
    disable_local_ca_jwt=False,
    external_entropy_access=False,
    identity_token_key="string",
    allowed_managed_keys=["string"],
    audit_non_hmac_request_keys=["string"],
    local=False,
    kubernetes_host="string",
    max_lease_ttl_seconds=0,
    namespace="string",
    options={
        "string": "string",
    },
    passthrough_request_headers=["string"],
    allowed_response_headers=["string"],
    plugin_version="string",
    seal_wrap=False,
    service_account_jwt="string")
const examplesecretBackendResourceResourceFromKubernetessecretBackend = new vault.kubernetes.SecretBackend("examplesecretBackendResourceResourceFromKubernetessecretBackend", {
    path: "string",
    kubernetesCaCert: "string",
    listingVisibility: "string",
    auditNonHmacResponseKeys: ["string"],
    defaultLeaseTtlSeconds: 0,
    delegatedAuthAccessors: ["string"],
    description: "string",
    disableLocalCaJwt: false,
    externalEntropyAccess: false,
    identityTokenKey: "string",
    allowedManagedKeys: ["string"],
    auditNonHmacRequestKeys: ["string"],
    local: false,
    kubernetesHost: "string",
    maxLeaseTtlSeconds: 0,
    namespace: "string",
    options: {
        string: "string",
    },
    passthroughRequestHeaders: ["string"],
    allowedResponseHeaders: ["string"],
    pluginVersion: "string",
    sealWrap: false,
    serviceAccountJwt: "string",
});
type: vault:kubernetes:SecretBackend
properties:
    allowedManagedKeys:
        - string
    allowedResponseHeaders:
        - string
    auditNonHmacRequestKeys:
        - string
    auditNonHmacResponseKeys:
        - string
    defaultLeaseTtlSeconds: 0
    delegatedAuthAccessors:
        - string
    description: string
    disableLocalCaJwt: false
    externalEntropyAccess: false
    identityTokenKey: string
    kubernetesCaCert: string
    kubernetesHost: string
    listingVisibility: string
    local: false
    maxLeaseTtlSeconds: 0
    namespace: string
    options:
        string: string
    passthroughRequestHeaders:
        - string
    path: string
    pluginVersion: string
    sealWrap: false
    serviceAccountJwt: 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:
- Path string
- Where the secret backend will be mounted
- AllowedManaged List<string>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- AllowedResponse List<string>Headers 
- List of headers to allow and pass from the request to the plugin
- AuditNon List<string>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- AuditNon List<string>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- DefaultLease intTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- DelegatedAuth List<string>Accessors 
- List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount
- DisableLocal boolCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- ExternalEntropy boolAccess 
- Enable the secrets engine to access Vault's external entropy source
- IdentityToken stringKey 
- The key to use for signing plugin workload identity tokens
- KubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- KubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- ListingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- MaxLease intTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- PassthroughRequest List<string>Headers 
- List of headers to allow and pass from the request to the plugin
- PluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- SealWrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- ServiceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- Path string
- Where the secret backend will be mounted
- AllowedManaged []stringKeys 
- List of managed key registry entry names that the mount in question is allowed to access
- AllowedResponse []stringHeaders 
- List of headers to allow and pass from the request to the plugin
- AuditNon []stringHmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- AuditNon []stringHmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- DefaultLease intTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- DelegatedAuth []stringAccessors 
- List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount
- DisableLocal boolCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- ExternalEntropy boolAccess 
- Enable the secrets engine to access Vault's external entropy source
- IdentityToken stringKey 
- The key to use for signing plugin workload identity tokens
- KubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- KubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- ListingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- MaxLease intTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- PassthroughRequest []stringHeaders 
- List of headers to allow and pass from the request to the plugin
- PluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- SealWrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- ServiceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- path String
- Where the secret backend will be mounted
- allowedManaged List<String>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon List<String>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon List<String>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease IntegerTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth List<String>Accessors 
- List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount
- disableLocal BooleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy BooleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken StringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa StringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost String
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility String
- Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease IntegerTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- pluginVersion String
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap Boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount StringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- path string
- Where the secret backend will be mounted
- allowedManaged string[]Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse string[]Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon string[]Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon string[]Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease numberTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth string[]Accessors 
- List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount
- disableLocal booleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy booleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken stringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease numberTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest string[]Headers 
- List of headers to allow and pass from the request to the plugin
- pluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- path str
- Where the secret backend will be mounted
- 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.
- default_lease_ intttl_ seconds 
- Default lease duration for tokens and secrets in seconds
- delegated_auth_ Sequence[str]accessors 
- List of headers to allow and pass from the request to the plugin
- description str
- Human-friendly description of the mount
- disable_local_ boolca_ jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- external_entropy_ boolaccess 
- Enable the secrets engine to access Vault's external entropy source
- identity_token_ strkey 
- The key to use for signing plugin workload identity tokens
- kubernetes_ca_ strcert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetes_host str
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listing_visibility str
- Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max_lease_ intttl_ seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- plugin_version str
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- seal_wrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service_account_ strjwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- path String
- Where the secret backend will be mounted
- allowedManaged List<String>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon List<String>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon List<String>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease NumberTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth List<String>Accessors 
- List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount
- disableLocal BooleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy BooleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken StringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa StringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost String
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility String
- Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease NumberTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- pluginVersion String
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap Boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount StringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
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,
        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,
        default_lease_ttl_seconds: Optional[int] = None,
        delegated_auth_accessors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        disable_local_ca_jwt: Optional[bool] = None,
        external_entropy_access: Optional[bool] = None,
        identity_token_key: Optional[str] = None,
        kubernetes_ca_cert: Optional[str] = None,
        kubernetes_host: 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,
        seal_wrap: Optional[bool] = None,
        service_account_jwt: Optional[str] = None) -> SecretBackendfunc 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:kubernetes: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
- AllowedManaged List<string>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- AllowedResponse List<string>Headers 
- List of headers to allow and pass from the request to the plugin
- AuditNon List<string>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- AuditNon List<string>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- DefaultLease intTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- DelegatedAuth List<string>Accessors 
- List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount
- DisableLocal boolCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- ExternalEntropy boolAccess 
- Enable the secrets engine to access Vault's external entropy source
- IdentityToken stringKey 
- The key to use for signing plugin workload identity tokens
- KubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- KubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- ListingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- MaxLease intTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- PassthroughRequest List<string>Headers 
- List of headers to allow and pass from the request to the plugin
- Path string
- Where the secret backend will be mounted
- PluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- SealWrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- ServiceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- Accessor string
- Accessor of the mount
- AllowedManaged []stringKeys 
- List of managed key registry entry names that the mount in question is allowed to access
- AllowedResponse []stringHeaders 
- List of headers to allow and pass from the request to the plugin
- AuditNon []stringHmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- AuditNon []stringHmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- DefaultLease intTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- DelegatedAuth []stringAccessors 
- List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount
- DisableLocal boolCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- ExternalEntropy boolAccess 
- Enable the secrets engine to access Vault's external entropy source
- IdentityToken stringKey 
- The key to use for signing plugin workload identity tokens
- KubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- KubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- ListingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- MaxLease intTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- Namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- PassthroughRequest []stringHeaders 
- List of headers to allow and pass from the request to the plugin
- Path string
- Where the secret backend will be mounted
- PluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- SealWrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- ServiceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- accessor String
- Accessor of the mount
- allowedManaged List<String>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon List<String>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon List<String>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease IntegerTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth List<String>Accessors 
- List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount
- disableLocal BooleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy BooleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken StringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa StringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost String
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility String
- Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease IntegerTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- path String
- Where the secret backend will be mounted
- pluginVersion String
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap Boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount StringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- accessor string
- Accessor of the mount
- allowedManaged string[]Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse string[]Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon string[]Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon string[]Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease numberTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth string[]Accessors 
- List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount
- disableLocal booleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy booleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken stringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa stringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost string
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility string
- Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease numberTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest string[]Headers 
- List of headers to allow and pass from the request to the plugin
- path string
- Where the secret backend will be mounted
- pluginVersion string
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount stringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- accessor str
- Accessor of the mount
- 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.
- default_lease_ intttl_ seconds 
- Default lease duration for tokens and secrets in seconds
- delegated_auth_ Sequence[str]accessors 
- List of headers to allow and pass from the request to the plugin
- description str
- Human-friendly description of the mount
- disable_local_ boolca_ jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- external_entropy_ boolaccess 
- Enable the secrets engine to access Vault's external entropy source
- identity_token_ strkey 
- The key to use for signing plugin workload identity tokens
- kubernetes_ca_ strcert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetes_host str
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listing_visibility str
- Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max_lease_ intttl_ seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace str
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- Where the secret backend will be mounted
- plugin_version str
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- seal_wrap bool
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service_account_ strjwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
- accessor String
- Accessor of the mount
- allowedManaged List<String>Keys 
- List of managed key registry entry names that the mount in question is allowed to access
- allowedResponse List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- auditNon List<String>Hmac Request Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- auditNon List<String>Hmac Response Keys 
- Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- defaultLease NumberTtl Seconds 
- Default lease duration for tokens and secrets in seconds
- delegatedAuth List<String>Accessors 
- List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount
- disableLocal BooleanCa Jwt 
- Disable defaulting to the local CA certificate and service account JWT when Vault is running in a Kubernetes pod.
- externalEntropy BooleanAccess 
- Enable the secrets engine to access Vault's external entropy source
- identityToken StringKey 
- The key to use for signing plugin workload identity tokens
- kubernetesCa StringCert 
- A PEM-encoded CA certificate used by the secrets engine to verify the Kubernetes API server certificate. Defaults to the local pod’s CA if Vault is running in Kubernetes. Otherwise, defaults to the root CA set where Vault is running.
- kubernetesHost String
- The Kubernetes API URL to connect to. Required if the
standard pod environment variables KUBERNETES_SERVICE_HOSTorKUBERNETES_SERVICE_PORTare not set on the host that Vault is running on.
- listingVisibility String
- Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- maxLease NumberTtl Seconds 
- Maximum possible lease duration for tokens and secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The namespaceis 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
- passthroughRequest List<String>Headers 
- List of headers to allow and pass from the request to the plugin
- path String
- Where the secret backend will be mounted
- pluginVersion String
- Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- sealWrap Boolean
- Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- serviceAccount StringJwt 
- The JSON web token of the service account used by the secrets engine to manage Kubernetes credentials. Defaults to the local pod’s JWT if Vault is running in Kubernetes.
Import
The Kubernetes secret backend can be imported using its path e.g.
$ pulumi import vault:kubernetes/secretBackend:SecretBackend config kubernetes
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 vaultTerraform Provider.