1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. terraformcloud
  5. SecretBackend
HashiCorp Vault v7.3.0 published on Tuesday, Sep 9, 2025 by Pulumi

vault.terraformcloud.SecretBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v7.3.0 published on Tuesday, Sep 9, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const test = new vault.terraformcloud.SecretBackend("test", {
        backend: "terraform",
        description: "Manages the Terraform Cloud backend",
        token: "V0idfhi2iksSDU234ucdbi2nidsi...",
    });
    
    import pulumi
    import pulumi_vault as vault
    
    test = vault.terraformcloud.SecretBackend("test",
        backend="terraform",
        description="Manages the Terraform Cloud backend",
        token="V0idfhi2iksSDU234ucdbi2nidsi...")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v7/go/vault/terraformcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := terraformcloud.NewSecretBackend(ctx, "test", &terraformcloud.SecretBackendArgs{
    			Backend:     pulumi.String("terraform"),
    			Description: pulumi.String("Manages the Terraform Cloud backend"),
    			Token:       pulumi.String("V0idfhi2iksSDU234ucdbi2nidsi..."),
    		})
    		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.TerraformCloud.SecretBackend("test", new()
        {
            Backend = "terraform",
            Description = "Manages the Terraform Cloud backend",
            Token = "V0idfhi2iksSDU234ucdbi2nidsi...",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.terraformcloud.SecretBackend;
    import com.pulumi.vault.terraformcloud.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()
                .backend("terraform")
                .description("Manages the Terraform Cloud backend")
                .token("V0idfhi2iksSDU234ucdbi2nidsi...")
                .build());
    
        }
    }
    
    resources:
      test:
        type: vault:terraformcloud:SecretBackend
        properties:
          backend: terraform
          description: Manages the Terraform Cloud backend
          token: V0idfhi2iksSDU234ucdbi2nidsi...
    

    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: Optional[SecretBackendArgs] = None,
                      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,
                      backend: Optional[str] = None,
                      base_path: 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,
                      plugin_version: 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 = null, CustomResourceOptions? opts = null)
    public SecretBackend(String name, SecretBackendArgs args)
    public SecretBackend(String name, SecretBackendArgs args, CustomResourceOptions options)
    
    type: vault:terraformcloud: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 examplesecretBackendResourceResourceFromTerraformcloudsecretBackend = new Vault.TerraformCloud.SecretBackend("examplesecretBackendResourceResourceFromTerraformcloudsecretBackend", new()
    {
        Address = "string",
        AllowedManagedKeys = new[]
        {
            "string",
        },
        AllowedResponseHeaders = new[]
        {
            "string",
        },
        AuditNonHmacRequestKeys = new[]
        {
            "string",
        },
        AuditNonHmacResponseKeys = new[]
        {
            "string",
        },
        Backend = "string",
        BasePath = "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",
        },
        PluginVersion = "string",
        SealWrap = false,
        Token = "string",
    });
    
    example, err := terraformcloud.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromTerraformcloudsecretBackend", &terraformcloud.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"),
    	},
    	Backend:                pulumi.String("string"),
    	BasePath:               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"),
    	},
    	PluginVersion: pulumi.String("string"),
    	SealWrap:      pulumi.Bool(false),
    	Token:         pulumi.String("string"),
    })
    
    var examplesecretBackendResourceResourceFromTerraformcloudsecretBackend = new com.pulumi.vault.terraformcloud.SecretBackend("examplesecretBackendResourceResourceFromTerraformcloudsecretBackend", com.pulumi.vault.terraformcloud.SecretBackendArgs.builder()
        .address("string")
        .allowedManagedKeys("string")
        .allowedResponseHeaders("string")
        .auditNonHmacRequestKeys("string")
        .auditNonHmacResponseKeys("string")
        .backend("string")
        .basePath("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")
        .pluginVersion("string")
        .sealWrap(false)
        .token("string")
        .build());
    
    examplesecret_backend_resource_resource_from_terraformcloudsecret_backend = vault.terraformcloud.SecretBackend("examplesecretBackendResourceResourceFromTerraformcloudsecretBackend",
        address="string",
        allowed_managed_keys=["string"],
        allowed_response_headers=["string"],
        audit_non_hmac_request_keys=["string"],
        audit_non_hmac_response_keys=["string"],
        backend="string",
        base_path="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"],
        plugin_version="string",
        seal_wrap=False,
        token="string")
    
    const examplesecretBackendResourceResourceFromTerraformcloudsecretBackend = new vault.terraformcloud.SecretBackend("examplesecretBackendResourceResourceFromTerraformcloudsecretBackend", {
        address: "string",
        allowedManagedKeys: ["string"],
        allowedResponseHeaders: ["string"],
        auditNonHmacRequestKeys: ["string"],
        auditNonHmacResponseKeys: ["string"],
        backend: "string",
        basePath: "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"],
        pluginVersion: "string",
        sealWrap: false,
        token: "string",
    });
    
    type: vault:terraformcloud:SecretBackend
    properties:
        address: string
        allowedManagedKeys:
            - string
        allowedResponseHeaders:
            - string
        auditNonHmacRequestKeys:
            - string
        auditNonHmacResponseKeys:
            - string
        backend: string
        basePath: 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
        pluginVersion: 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
    AllowedManagedKeys List<string>
    List of managed key registry entry names that the mount in question is allowed to access
    AllowedResponseHeaders List<string>
    List of headers to allow and pass from the request to the plugin
    AuditNonHmacRequestKeys List<string>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    AuditNonHmacResponseKeys List<string>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    Backend string
    BasePath string
    DefaultLeaseTtlSeconds int
    Default lease duration for secrets in seconds
    DelegatedAuthAccessors List<string>
    List of headers to allow and pass from the request to the plugin
    Description string
    Human-friendly description of the mount for the backend.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    ExternalEntropyAccess bool
    Enable the secrets engine to access Vault's external entropy source
    ForceNoCache bool
    If set to true, disables caching.
    IdentityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    MaxLeaseTtlSeconds int
    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
    PassthroughRequestHeaders List<string>
    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
    Token string
    Address string
    AllowedManagedKeys []string
    List of managed key registry entry names that the mount in question is allowed to access
    AllowedResponseHeaders []string
    List of headers to allow and pass from the request to the plugin
    AuditNonHmacRequestKeys []string
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    AuditNonHmacResponseKeys []string
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    Backend string
    BasePath string
    DefaultLeaseTtlSeconds int
    Default lease duration for secrets in seconds
    DelegatedAuthAccessors []string
    List of headers to allow and pass from the request to the plugin
    Description string
    Human-friendly description of the mount for the backend.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    ExternalEntropyAccess bool
    Enable the secrets engine to access Vault's external entropy source
    ForceNoCache bool
    If set to true, disables caching.
    IdentityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    MaxLeaseTtlSeconds int
    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
    PassthroughRequestHeaders []string
    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
    Token string
    address String
    allowedManagedKeys List<String>
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders List<String>
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend String
    basePath String
    defaultLeaseTtlSeconds Integer
    Default lease duration for secrets in seconds
    delegatedAuthAccessors List<String>
    List of headers to allow and pass from the request to the plugin
    description String
    Human-friendly description of the mount for the backend.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess Boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache Boolean
    If set to true, disables caching.
    identityTokenKey String
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds Integer
    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
    passthroughRequestHeaders List<String>
    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
    token String
    address string
    allowedManagedKeys string[]
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders string[]
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys string[]
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys string[]
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend string
    basePath string
    defaultLeaseTtlSeconds number
    Default lease duration for secrets in seconds
    delegatedAuthAccessors string[]
    List of headers to allow and pass from the request to the plugin
    description string
    Human-friendly description of the mount for the backend.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache boolean
    If set to true, disables caching.
    identityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds number
    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
    passthroughRequestHeaders string[]
    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
    token string
    address str
    allowed_managed_keys Sequence[str]
    List of managed key registry entry names that the mount in question is allowed to access
    allowed_response_headers Sequence[str]
    List of headers to allow and pass from the request to the plugin
    audit_non_hmac_request_keys Sequence[str]
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    audit_non_hmac_response_keys Sequence[str]
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend str
    base_path str
    default_lease_ttl_seconds int
    Default lease duration for secrets in seconds
    delegated_auth_accessors Sequence[str]
    List of headers to allow and pass from the request to the plugin
    description str
    Human-friendly description of the mount for the backend.
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    external_entropy_access bool
    Enable the secrets engine to access Vault's external entropy source
    force_no_cache bool
    If set to true, disables caching.
    identity_token_key str
    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
    Local mount flag that can be explicitly set to true to enforce local mount in HA environment
    max_lease_ttl_seconds int
    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_headers Sequence[str]
    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
    token str
    address String
    allowedManagedKeys List<String>
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders List<String>
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend String
    basePath String
    defaultLeaseTtlSeconds Number
    Default lease duration for secrets in seconds
    delegatedAuthAccessors List<String>
    List of headers to allow and pass from the request to the plugin
    description String
    Human-friendly description of the mount for the backend.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess Boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache Boolean
    If set to true, disables caching.
    identityTokenKey String
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds Number
    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
    passthroughRequestHeaders List<String>
    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
    token String

    Outputs

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

    Accessor string
    Accessor of the mount
    Id string
    The provider-assigned unique ID for this managed resource.
    Accessor string
    Accessor of the mount
    Id string
    The provider-assigned unique ID for this managed resource.
    accessor String
    Accessor of the mount
    id String
    The provider-assigned unique ID for this managed resource.
    accessor string
    Accessor of the mount
    id string
    The provider-assigned unique ID for this managed resource.
    accessor str
    Accessor of the mount
    id str
    The provider-assigned unique ID for this managed resource.
    accessor String
    Accessor of the mount
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SecretBackend Resource

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

    public static get(name: string, id: Input<ID>, state?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            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,
            backend: Optional[str] = None,
            base_path: 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,
            plugin_version: 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:terraformcloud: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.
    The following state arguments are supported:
    Accessor string
    Accessor of the mount
    Address string
    AllowedManagedKeys List<string>
    List of managed key registry entry names that the mount in question is allowed to access
    AllowedResponseHeaders List<string>
    List of headers to allow and pass from the request to the plugin
    AuditNonHmacRequestKeys List<string>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    AuditNonHmacResponseKeys List<string>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    Backend string
    BasePath string
    DefaultLeaseTtlSeconds int
    Default lease duration for secrets in seconds
    DelegatedAuthAccessors List<string>
    List of headers to allow and pass from the request to the plugin
    Description string
    Human-friendly description of the mount for the backend.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    ExternalEntropyAccess bool
    Enable the secrets engine to access Vault's external entropy source
    ForceNoCache bool
    If set to true, disables caching.
    IdentityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    MaxLeaseTtlSeconds int
    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
    PassthroughRequestHeaders List<string>
    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
    Token string
    Accessor string
    Accessor of the mount
    Address string
    AllowedManagedKeys []string
    List of managed key registry entry names that the mount in question is allowed to access
    AllowedResponseHeaders []string
    List of headers to allow and pass from the request to the plugin
    AuditNonHmacRequestKeys []string
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    AuditNonHmacResponseKeys []string
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    Backend string
    BasePath string
    DefaultLeaseTtlSeconds int
    Default lease duration for secrets in seconds
    DelegatedAuthAccessors []string
    List of headers to allow and pass from the request to the plugin
    Description string
    Human-friendly description of the mount for the backend.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    ExternalEntropyAccess bool
    Enable the secrets engine to access Vault's external entropy source
    ForceNoCache bool
    If set to true, disables caching.
    IdentityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    MaxLeaseTtlSeconds int
    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
    PassthroughRequestHeaders []string
    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
    Token string
    accessor String
    Accessor of the mount
    address String
    allowedManagedKeys List<String>
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders List<String>
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend String
    basePath String
    defaultLeaseTtlSeconds Integer
    Default lease duration for secrets in seconds
    delegatedAuthAccessors List<String>
    List of headers to allow and pass from the request to the plugin
    description String
    Human-friendly description of the mount for the backend.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess Boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache Boolean
    If set to true, disables caching.
    identityTokenKey String
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds Integer
    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
    passthroughRequestHeaders List<String>
    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
    token String
    accessor string
    Accessor of the mount
    address string
    allowedManagedKeys string[]
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders string[]
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys string[]
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys string[]
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend string
    basePath string
    defaultLeaseTtlSeconds number
    Default lease duration for secrets in seconds
    delegatedAuthAccessors string[]
    List of headers to allow and pass from the request to the plugin
    description string
    Human-friendly description of the mount for the backend.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache boolean
    If set to true, disables caching.
    identityTokenKey string
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds number
    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
    passthroughRequestHeaders string[]
    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
    token string
    accessor str
    Accessor of the mount
    address str
    allowed_managed_keys Sequence[str]
    List of managed key registry entry names that the mount in question is allowed to access
    allowed_response_headers Sequence[str]
    List of headers to allow and pass from the request to the plugin
    audit_non_hmac_request_keys Sequence[str]
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    audit_non_hmac_response_keys Sequence[str]
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend str
    base_path str
    default_lease_ttl_seconds int
    Default lease duration for secrets in seconds
    delegated_auth_accessors Sequence[str]
    List of headers to allow and pass from the request to the plugin
    description str
    Human-friendly description of the mount for the backend.
    disable_remount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    external_entropy_access bool
    Enable the secrets engine to access Vault's external entropy source
    force_no_cache bool
    If set to true, disables caching.
    identity_token_key str
    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
    Local mount flag that can be explicitly set to true to enforce local mount in HA environment
    max_lease_ttl_seconds int
    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_headers Sequence[str]
    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
    token str
    accessor String
    Accessor of the mount
    address String
    allowedManagedKeys List<String>
    List of managed key registry entry names that the mount in question is allowed to access
    allowedResponseHeaders List<String>
    List of headers to allow and pass from the request to the plugin
    auditNonHmacRequestKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
    auditNonHmacResponseKeys List<String>
    Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
    backend String
    basePath String
    defaultLeaseTtlSeconds Number
    Default lease duration for secrets in seconds
    delegatedAuthAccessors List<String>
    List of headers to allow and pass from the request to the plugin
    description String
    Human-friendly description of the mount for the backend.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    externalEntropyAccess Boolean
    Enable the secrets engine to access Vault's external entropy source
    forceNoCache Boolean
    If set to true, disables caching.
    identityTokenKey String
    The key to use for signing plugin workload identity tokens
    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
    maxLeaseTtlSeconds Number
    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
    passthroughRequestHeaders List<String>
    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
    token String

    Import

    Terraform Cloud secret backends can be imported using the backend, e.g.

    $ pulumi import vault:terraformcloud/secretBackend:SecretBackend example terraform
    

    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.
    vault logo
    HashiCorp Vault v7.3.0 published on Tuesday, Sep 9, 2025 by Pulumi