published on Saturday, Aug 15, 2026 by Pulumi
published on Saturday, Aug 15, 2026 by Pulumi
Creates a Terraform Cloud Secret Backend for Vault. Terraform Cloud secret backends can then create Terraform Cloud tokens, once a role with the appropriate creds has been added to the backend.
Important All data provided in the resource configuration will be written in cleartext to state and plan files generated by Terraform, and will appear in the console output when Terraform runs. Protect these artifacts accordingly. See the main provider documentation for more details.
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.ArrayList;
import java.util.Arrays;
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...
pulumi {
required_providers {
vault = {
source = "pulumi/vault"
}
}
}
resource "vault_terraformcloud_secretbackend" "test" {
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_automated_rotation: Optional[bool] = None,
disable_remount: Optional[bool] = None,
explicit_max_ttl: Optional[int] = 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,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
seal_wrap: Optional[bool] = None,
token: Optional[str] = None,
token_wo: Optional[str] = None,
token_wo_version: Optional[int] = 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.
resource "vault_terraformcloud_secret_backend" "name" {
# resource properties
}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",
DisableAutomatedRotation = false,
DisableRemount = false,
ExplicitMaxTtl = 0,
ExternalEntropyAccess = false,
ForceNoCache = false,
IdentityTokenKey = "string",
ListingVisibility = "string",
Local = false,
MaxLeaseTtlSeconds = 0,
Namespace = "string",
Options =
{
{ "string", "string" },
},
PassthroughRequestHeaders = new[]
{
"string",
},
PluginVersion = "string",
RotationPeriod = 0,
RotationSchedule = "string",
RotationWindow = 0,
SealWrap = false,
Token = "string",
TokenWo = "string",
TokenWoVersion = 0,
});
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"),
DisableAutomatedRotation: pulumi.Bool(false),
DisableRemount: pulumi.Bool(false),
ExplicitMaxTtl: pulumi.Int(0),
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"),
RotationPeriod: pulumi.Int(0),
RotationSchedule: pulumi.String("string"),
RotationWindow: pulumi.Int(0),
SealWrap: pulumi.Bool(false),
Token: pulumi.String("string"),
TokenWo: pulumi.String("string"),
TokenWoVersion: pulumi.Int(0),
})
resource "vault_terraformcloud_secret_backend" "examplesecretBackendResourceResourceFromTerraformcloudsecretBackend" {
lifecycle {
create_before_destroy = true
}
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_automated_rotation = false
disable_remount = false
explicit_max_ttl = 0
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"
rotation_period = 0
rotation_schedule = "string"
rotation_window = 0
seal_wrap = false
token = "string"
token_wo = "string"
token_wo_version = 0
}
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")
.disableAutomatedRotation(false)
.disableRemount(false)
.explicitMaxTtl(0)
.externalEntropyAccess(false)
.forceNoCache(false)
.identityTokenKey("string")
.listingVisibility("string")
.local(false)
.maxLeaseTtlSeconds(0)
.namespace("string")
.options(Map.of("string", "string"))
.passthroughRequestHeaders("string")
.pluginVersion("string")
.rotationPeriod(0)
.rotationSchedule("string")
.rotationWindow(0)
.sealWrap(false)
.token("string")
.tokenWo("string")
.tokenWoVersion(0)
.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_automated_rotation=False,
disable_remount=False,
explicit_max_ttl=0,
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",
rotation_period=0,
rotation_schedule="string",
rotation_window=0,
seal_wrap=False,
token="string",
token_wo="string",
token_wo_version=0)
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",
disableAutomatedRotation: false,
disableRemount: false,
explicitMaxTtl: 0,
externalEntropyAccess: false,
forceNoCache: false,
identityTokenKey: "string",
listingVisibility: "string",
local: false,
maxLeaseTtlSeconds: 0,
namespace: "string",
options: {
string: "string",
},
passthroughRequestHeaders: ["string"],
pluginVersion: "string",
rotationPeriod: 0,
rotationSchedule: "string",
rotationWindow: 0,
sealWrap: false,
token: "string",
tokenWo: "string",
tokenWoVersion: 0,
});
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
disableAutomatedRotation: false
disableRemount: false
explicitMaxTtl: 0
externalEntropyAccess: false
forceNoCache: false
identityTokenKey: string
listingVisibility: string
local: false
maxLeaseTtlSeconds: 0
namespace: string
options:
string: string
passthroughRequestHeaders:
- string
pluginVersion: string
rotationPeriod: 0
rotationSchedule: string
rotationWindow: 0
sealWrap: false
token: string
tokenWo: string
tokenWoVersion: 0
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
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - Allowed
Managed List<string>Keys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response List<string>Headers - List of headers to allow and pass from the request to the plugin
- Audit
Non List<string>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non List<string>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- Backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - Base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth List<string>Accessors - List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount for the backend.
- Disable
Automated boolRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Explicit
Max intTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- 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 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
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Rotation
Period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - Rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- Token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- Token
Wo intVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- Address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - Allowed
Managed []stringKeys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response []stringHeaders - List of headers to allow and pass from the request to the plugin
- Audit
Non []stringHmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non []stringHmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- Backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - Base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth []stringAccessors - List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount for the backend.
- Disable
Automated boolRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Explicit
Max intTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- 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 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
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Rotation
Period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - Rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- Token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- Token
Wo intVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed_
managed_ list(string)keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed_
response_ list(string)headers - List of headers to allow and pass from the request to the plugin
- audit_
non_ list(string)hmac_ request_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit_
non_ list(string)hmac_ response_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base_
path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- default_
lease_ numberttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ list(string)accessors - List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount for the backend.
- disable_
automated_ boolrotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit_
max_ numberttl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ stringkey - The key to use for signing plugin workload identity tokens
- listing_
visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max_
lease_ numberttl_ seconds - Maximum possible lease duration for secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough_
request_ list(string)headers - List of headers to allow and pass from the request to the plugin
- plugin_
version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation_
period number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation_
schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation_
window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- token_
wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token_
wo_ numberversion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- address String
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend String
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path String - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease IntegerTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount for the backend.
- disable
Automated BooleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max IntegerTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease IntegerTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period Integer - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule String - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window Integer - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token String
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo IntegerVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed string[]Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response string[]Headers - List of headers to allow and pass from the request to the plugin
- audit
Non string[]Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non string[]Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease numberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth string[]Accessors - List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount for the backend.
- disable
Automated booleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max numberTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease numberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token string
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo numberVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- address str
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - 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.
- backend str
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base_
path str - Specifies the base path for the Terraform Cloud or Enterprise API.
- default_
lease_ intttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ Sequence[str]accessors - List of headers to allow and pass from the request to the plugin
- description str
- Human-friendly description of the mount for the backend.
- disable_
automated_ boolrotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit_
max_ intttl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ strkey - The key to use for signing plugin workload identity tokens
- listing_
visibility str - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- 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 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'
- rotation_
period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation_
schedule str - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation_
window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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
- The Terraform Cloud management token this backend should use to issue new tokens.
- token_
wo str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token_
wo_ intversion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- address String
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend String
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path String - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease NumberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount for the backend.
- disable
Automated BooleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max NumberTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease NumberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period Number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule String - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window Number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token String
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo NumberVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecretBackend resource produces the following output properties:
Look up Existing SecretBackend Resource
Get an existing SecretBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accessor: Optional[str] = None,
address: Optional[str] = None,
allowed_managed_keys: Optional[Sequence[str]] = None,
allowed_response_headers: Optional[Sequence[str]] = None,
audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
audit_non_hmac_response_keys: Optional[Sequence[str]] = None,
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_automated_rotation: Optional[bool] = None,
disable_remount: Optional[bool] = None,
explicit_max_ttl: Optional[int] = 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,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
seal_wrap: Optional[bool] = None,
token: Optional[str] = None,
token_wo: Optional[str] = None,
token_wo_version: Optional[int] = 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:terraformcloud:SecretBackend get: id: ${id}import {
to = vault_terraformcloud_secret_backend.example
id = "${id}"
}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accessor string
- Accessor of the mount
- Address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - Allowed
Managed List<string>Keys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response List<string>Headers - List of headers to allow and pass from the request to the plugin
- Audit
Non List<string>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non List<string>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- Backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - Base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth List<string>Accessors - List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount for the backend.
- Disable
Automated boolRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Explicit
Max intTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- 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 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
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Rotation
Period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - Rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- Token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- Token
Wo intVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- Accessor string
- Accessor of the mount
- Address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - Allowed
Managed []stringKeys - List of managed key registry entry names that the mount in question is allowed to access
- Allowed
Response []stringHeaders - List of headers to allow and pass from the request to the plugin
- Audit
Non []stringHmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- Audit
Non []stringHmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- Backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - Base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- Default
Lease intTtl Seconds - Default lease duration for secrets in seconds
- Delegated
Auth []stringAccessors - List of headers to allow and pass from the request to the plugin
- Description string
- Human-friendly description of the mount for the backend.
- Disable
Automated boolRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- Explicit
Max intTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringKey - The key to use for signing plugin workload identity tokens
- Listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- Local bool
- 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 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
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- Rotation
Period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - Rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - Rotation
Window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- Token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- Token
Wo intVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- accessor string
- Accessor of the mount
- address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed_
managed_ list(string)keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed_
response_ list(string)headers - List of headers to allow and pass from the request to the plugin
- audit_
non_ list(string)hmac_ request_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit_
non_ list(string)hmac_ response_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base_
path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- default_
lease_ numberttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ list(string)accessors - List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount for the backend.
- disable_
automated_ boolrotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit_
max_ numberttl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ stringkey - The key to use for signing plugin workload identity tokens
- listing_
visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max_
lease_ numberttl_ seconds - Maximum possible lease duration for secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough_
request_ list(string)headers - List of headers to allow and pass from the request to the plugin
- plugin_
version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation_
period number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation_
schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation_
window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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 string
- The Terraform Cloud management token this backend should use to issue new tokens.
- token_
wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token_
wo_ numberversion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- accessor String
- Accessor of the mount
- address String
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend String
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path String - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease IntegerTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount for the backend.
- disable
Automated BooleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max IntegerTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease IntegerTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period Integer - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule String - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window Integer - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token String
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo IntegerVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- accessor string
- Accessor of the mount
- address string
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed string[]Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response string[]Headers - List of headers to allow and pass from the request to the plugin
- audit
Non string[]Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non string[]Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend string
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path string - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease numberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth string[]Accessors - List of headers to allow and pass from the request to the plugin
- description string
- Human-friendly description of the mount for the backend.
- disable
Automated booleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max numberTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility string - Specifies whether to show this mount in the UI-specific listing endpoint
- local boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease numberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace string
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version string - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule string - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token string
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo string - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo numberVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- accessor str
- Accessor of the mount
- address str
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - 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.
- backend str
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base_
path str - Specifies the base path for the Terraform Cloud or Enterprise API.
- default_
lease_ intttl_ seconds - Default lease duration for secrets in seconds
- delegated_
auth_ Sequence[str]accessors - List of headers to allow and pass from the request to the plugin
- description str
- Human-friendly description of the mount for the backend.
- disable_
automated_ boolrotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit_
max_ intttl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ strkey - The key to use for signing plugin workload identity tokens
- listing_
visibility str - Specifies whether to show this mount in the UI-specific listing endpoint
- local bool
- 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 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'
- rotation_
period int - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation_
schedule str - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation_
window int - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.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
- The Terraform Cloud management token this backend should use to issue new tokens.
- token_
wo str - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token_
wo_ intversion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
- accessor String
- Accessor of the mount
- address String
- The address of the Terraform Cloud server, if using
Terraform Enterprise, provided as
"protocol://host:port". The default ishttps://app.terraform.iofor Terraform Cloud. - allowed
Managed List<String>Keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed
Response List<String>Headers - List of headers to allow and pass from the request to the plugin
- audit
Non List<String>Hmac Request Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit
Non List<String>Hmac Response Keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- backend String
- The unique location this backend should be mounted at. Must not begin or end with a
/. Defaults toterraform. - base
Path String - Specifies the base path for the Terraform Cloud or Enterprise API.
- default
Lease NumberTtl Seconds - Default lease duration for secrets in seconds
- delegated
Auth List<String>Accessors - List of headers to allow and pass from the request to the plugin
- description String
- Human-friendly description of the mount for the backend.
- disable
Automated BooleanRotation - Cancels all upcoming rotations of the root token until unset. Requires Vault Enterprise 2.2.0+.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- explicit
Max NumberTtl - The maximum amount of time in seconds the root token
issued by rotation is valid for. A value of
0uses the Terraform Cloud/Enterprise default token lifetime. Requires Vault 2.2.0+. - external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringKey - The key to use for signing plugin workload identity tokens
- listing
Visibility String - Specifies whether to show this mount in the UI-specific listing endpoint
- local Boolean
- Local mount flag that can be explicitly set to true to enforce local mount in HA environment
- max
Lease NumberTtl Seconds - Maximum possible lease duration for secrets in seconds
- namespace String
- The namespace to provision the resource in.
The value should not contain leading or trailing forward slashes.
The
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
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- plugin
Version String - Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
- rotation
Period Number - The amount of time in seconds Vault should wait before
rotating the root token. A zero value tells Vault not to rotate the root token. The
minimum rotation period is 10 seconds. Requires Vault Enterprise 2.2.0+. Mutually
exclusive with
rotationSchedule. - rotation
Schedule String - The schedule, in cron-style time format
defining the schedule on which Vault should rotate the root token. Requires Vault
Enterprise 2.2.0+. Mutually exclusive with
rotationPeriod. - rotation
Window Number - The maximum amount of time in seconds allowed to complete
a rotation when a scheduled token rotation occurs. The default rotation window is
unbound and the minimum allowable window is
3600. Only valid withrotationSchedule. Requires Vault Enterprise 2.2.0+. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- token String
- The Terraform Cloud management token this backend should use to issue new tokens.
- token
Wo String - NOTE: This field is write-only and its value will not be updated in state as part of read operations. The Terraform Cloud management token this backend should use to issue new tokens. Note: This property is write-only and will not be read from the API.
- token
Wo NumberVersion The version of the
tokenWo. For more info see updating write-only attributes.Important Because Vault does not support reading the configured token back from the API, Terraform cannot detect and correct drift on
token. Changing the value, however, will overwrite the previously stored values.
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
vaultTerraform Provider.
published on Saturday, Aug 15, 2026 by Pulumi