Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. aws
  5. SecretBackend
HashiCorp Vault v7.2.0 published on Tuesday, Aug 19, 2025 by Pulumi
pulumi/pulumi-vault

vault.aws.SecretBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v7.2.0 published on Tuesday, Aug 19, 2025 by Pulumi
pulumi/pulumi-vault

    Import

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

    $ pulumi import vault:aws/secretBackend:SecretBackend aws aws

    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,
                  access_key: Optional[str] = None,
                  allowed_managed_keys: Optional[Sequence[str]] = None,
                  allowed_response_headers: Optional[Sequence[str]] = None,
                  audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
                  audit_non_hmac_response_keys: Optional[Sequence[str]] = None,
                  default_lease_ttl_seconds: Optional[int] = None,
                  delegated_auth_accessors: Optional[Sequence[str]] = None,
                  description: Optional[str] = None,
                  disable_automated_rotation: Optional[bool] = None,
                  disable_remount: Optional[bool] = None,
                  external_entropy_access: Optional[bool] = None,
                  force_no_cache: Optional[bool] = None,
                  iam_endpoint: Optional[str] = None,
                  identity_token_audience: Optional[str] = None,
                  identity_token_key: Optional[str] = None,
                  identity_token_ttl: Optional[int] = None,
                  listing_visibility: Optional[str] = None,
                  local: Optional[bool] = None,
                  max_lease_ttl_seconds: Optional[int] = None,
                  namespace: Optional[str] = None,
                  options: Optional[Mapping[str, str]] = None,
                  passthrough_request_headers: Optional[Sequence[str]] = None,
                  path: Optional[str] = None,
                  plugin_version: Optional[str] = None,
                  region: Optional[str] = None,
                  role_arn: Optional[str] = None,
                  rotation_period: Optional[int] = None,
                  rotation_schedule: Optional[str] = None,
                  rotation_window: Optional[int] = None,
                  seal_wrap: Optional[bool] = None,
                  secret_key: Optional[str] = None,
                  sts_endpoint: Optional[str] = None,
                  sts_fallback_endpoints: Optional[Sequence[str]] = None,
                  sts_fallback_regions: Optional[Sequence[str]] = None,
                  sts_region: Optional[str] = None,
                  username_template: 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:aws: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 vaultSecretBackendResource = new Vault.Aws.SecretBackend("vaultSecretBackendResource", new()
{
    AccessKey = "string",
    AllowedManagedKeys = new[]
    {
        "string",
    },
    AllowedResponseHeaders = new[]
    {
        "string",
    },
    AuditNonHmacRequestKeys = new[]
    {
        "string",
    },
    AuditNonHmacResponseKeys = new[]
    {
        "string",
    },
    DefaultLeaseTtlSeconds = 0,
    DelegatedAuthAccessors = new[]
    {
        "string",
    },
    Description = "string",
    DisableAutomatedRotation = false,
    DisableRemount = false,
    ExternalEntropyAccess = false,
    ForceNoCache = false,
    IamEndpoint = "string",
    IdentityTokenAudience = "string",
    IdentityTokenKey = "string",
    IdentityTokenTtl = 0,
    ListingVisibility = "string",
    Local = false,
    MaxLeaseTtlSeconds = 0,
    Namespace = "string",
    Options = 
    {
        { "string", "string" },
    },
    PassthroughRequestHeaders = new[]
    {
        "string",
    },
    Path = "string",
    PluginVersion = "string",
    Region = "string",
    RoleArn = "string",
    RotationPeriod = 0,
    RotationSchedule = "string",
    RotationWindow = 0,
    SealWrap = false,
    SecretKey = "string",
    StsEndpoint = "string",
    StsFallbackEndpoints = new[]
    {
        "string",
    },
    StsFallbackRegions = new[]
    {
        "string",
    },
    StsRegion = "string",
    UsernameTemplate = "string",
});

    example, err := aws.NewSecretBackend(ctx, "vaultSecretBackendResource", &aws.SecretBackendArgs{
	AccessKey: 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"),
	},
	DefaultLeaseTtlSeconds: pulumi.Int(0),
	DelegatedAuthAccessors: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:              pulumi.String("string"),
	DisableAutomatedRotation: pulumi.Bool(false),
	DisableRemount:           pulumi.Bool(false),
	ExternalEntropyAccess:    pulumi.Bool(false),
	ForceNoCache:             pulumi.Bool(false),
	IamEndpoint:              pulumi.String("string"),
	IdentityTokenAudience:    pulumi.String("string"),
	IdentityTokenKey:         pulumi.String("string"),
	IdentityTokenTtl:         pulumi.Int(0),
	ListingVisibility:        pulumi.String("string"),
	Local:                    pulumi.Bool(false),
	MaxLeaseTtlSeconds:       pulumi.Int(0),
	Namespace:                pulumi.String("string"),
	Options: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	PassthroughRequestHeaders: pulumi.StringArray{
		pulumi.String("string"),
	},
	Path:             pulumi.String("string"),
	PluginVersion:    pulumi.String("string"),
	Region:           pulumi.String("string"),
	RoleArn:          pulumi.String("string"),
	RotationPeriod:   pulumi.Int(0),
	RotationSchedule: pulumi.String("string"),
	RotationWindow:   pulumi.Int(0),
	SealWrap:         pulumi.Bool(false),
	SecretKey:        pulumi.String("string"),
	StsEndpoint:      pulumi.String("string"),
	StsFallbackEndpoints: pulumi.StringArray{
		pulumi.String("string"),
	},
	StsFallbackRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	StsRegion:        pulumi.String("string"),
	UsernameTemplate: pulumi.String("string"),
})

    var vaultSecretBackendResource = new com.pulumi.vault.aws.SecretBackend("vaultSecretBackendResource", com.pulumi.vault.aws.SecretBackendArgs.builder()
    .accessKey("string")
    .allowedManagedKeys("string")
    .allowedResponseHeaders("string")
    .auditNonHmacRequestKeys("string")
    .auditNonHmacResponseKeys("string")
    .defaultLeaseTtlSeconds(0)
    .delegatedAuthAccessors("string")
    .description("string")
    .disableAutomatedRotation(false)
    .disableRemount(false)
    .externalEntropyAccess(false)
    .forceNoCache(false)
    .iamEndpoint("string")
    .identityTokenAudience("string")
    .identityTokenKey("string")
    .identityTokenTtl(0)
    .listingVisibility("string")
    .local(false)
    .maxLeaseTtlSeconds(0)
    .namespace("string")
    .options(Map.of("string", "string"))
    .passthroughRequestHeaders("string")
    .path("string")
    .pluginVersion("string")
    .region("string")
    .roleArn("string")
    .rotationPeriod(0)
    .rotationSchedule("string")
    .rotationWindow(0)
    .sealWrap(false)
    .secretKey("string")
    .stsEndpoint("string")
    .stsFallbackEndpoints("string")
    .stsFallbackRegions("string")
    .stsRegion("string")
    .usernameTemplate("string")
    .build());

    vault_secret_backend_resource = vault.aws.SecretBackend("vaultSecretBackendResource",
    access_key="string",
    allowed_managed_keys=["string"],
    allowed_response_headers=["string"],
    audit_non_hmac_request_keys=["string"],
    audit_non_hmac_response_keys=["string"],
    default_lease_ttl_seconds=0,
    delegated_auth_accessors=["string"],
    description="string",
    disable_automated_rotation=False,
    disable_remount=False,
    external_entropy_access=False,
    force_no_cache=False,
    iam_endpoint="string",
    identity_token_audience="string",
    identity_token_key="string",
    identity_token_ttl=0,
    listing_visibility="string",
    local=False,
    max_lease_ttl_seconds=0,
    namespace="string",
    options={
        "string": "string",
    },
    passthrough_request_headers=["string"],
    path="string",
    plugin_version="string",
    region="string",
    role_arn="string",
    rotation_period=0,
    rotation_schedule="string",
    rotation_window=0,
    seal_wrap=False,
    secret_key="string",
    sts_endpoint="string",
    sts_fallback_endpoints=["string"],
    sts_fallback_regions=["string"],
    sts_region="string",
    username_template="string")

    const vaultSecretBackendResource = new vault.aws.SecretBackend("vaultSecretBackendResource", {
    accessKey: "string",
    allowedManagedKeys: ["string"],
    allowedResponseHeaders: ["string"],
    auditNonHmacRequestKeys: ["string"],
    auditNonHmacResponseKeys: ["string"],
    defaultLeaseTtlSeconds: 0,
    delegatedAuthAccessors: ["string"],
    description: "string",
    disableAutomatedRotation: false,
    disableRemount: false,
    externalEntropyAccess: false,
    forceNoCache: false,
    iamEndpoint: "string",
    identityTokenAudience: "string",
    identityTokenKey: "string",
    identityTokenTtl: 0,
    listingVisibility: "string",
    local: false,
    maxLeaseTtlSeconds: 0,
    namespace: "string",
    options: {
        string: "string",
    },
    passthroughRequestHeaders: ["string"],
    path: "string",
    pluginVersion: "string",
    region: "string",
    roleArn: "string",
    rotationPeriod: 0,
    rotationSchedule: "string",
    rotationWindow: 0,
    sealWrap: false,
    secretKey: "string",
    stsEndpoint: "string",
    stsFallbackEndpoints: ["string"],
    stsFallbackRegions: ["string"],
    stsRegion: "string",
    usernameTemplate: "string",
});

    type: vault:aws:SecretBackend
properties:
    accessKey: string
    allowedManagedKeys:
        - string
    allowedResponseHeaders:
        - string
    auditNonHmacRequestKeys:
        - string
    auditNonHmacResponseKeys:
        - string
    defaultLeaseTtlSeconds: 0
    delegatedAuthAccessors:
        - string
    description: string
    disableAutomatedRotation: false
    disableRemount: false
    externalEntropyAccess: false
    forceNoCache: false
    iamEndpoint: string
    identityTokenAudience: string
    identityTokenKey: string
    identityTokenTtl: 0
    listingVisibility: string
    local: false
    maxLeaseTtlSeconds: 0
    namespace: string
    options:
        string: string
    passthroughRequestHeaders:
        - string
    path: string
    pluginVersion: string
    region: string
    roleArn: string
    rotationPeriod: 0
    rotationSchedule: string
    rotationWindow: 0
    sealWrap: false
    secretKey: string
    stsEndpoint: string
    stsFallbackEndpoints:
        - string
    stsFallbackRegions:
        - string
    stsRegion: string
    usernameTemplate: 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:

    AccessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    IamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    IdentityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    IdentityTokenKey string
    The key to use for signing identity tokens.
    IdentityTokenTtl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    ListingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    Local bool
    Specifies if the secret backend is local only
    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
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    PluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    Region string
    The AWS region to make API calls against. Defaults to us-east-1.
    RoleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    RotationPeriod int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    RotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    RotationWindow 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. Requires Vault Enterprise 1.19+.
    SealWrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    SecretKey string
    The AWS Secret Access Key to use when generating new credentials.
    StsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    StsFallbackEndpoints List<string>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    StsFallbackRegions List<string>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    StsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    UsernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    AccessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    IamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    IdentityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    IdentityTokenKey string
    The key to use for signing identity tokens.
    IdentityTokenTtl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    ListingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    Local bool
    Specifies if the secret backend is local only
    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
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    PluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    Region string
    The AWS region to make API calls against. Defaults to us-east-1.
    RoleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    RotationPeriod int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    RotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    RotationWindow 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. Requires Vault Enterprise 1.19+.
    SealWrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    SecretKey string
    The AWS Secret Access Key to use when generating new credentials.
    StsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    StsFallbackEndpoints []string
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    StsFallbackRegions []string
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    StsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    UsernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey String
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint String
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience String
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey String
    The key to use for signing identity tokens.
    identityTokenTtl Integer
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility String
    Specifies whether to show this mount in the UI-specific listing endpoint
    local Boolean
    Specifies if the secret backend is local only
    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
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion String
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region String
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn String
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod Integer
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule String
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap Boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey String
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint String
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints List<String>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions List<String>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion String
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate String
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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.
    disableAutomatedRotation boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey string
    The key to use for signing identity tokens.
    identityTokenTtl number
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    local boolean
    Specifies if the secret backend is local only
    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
    path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region string
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod number
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey string
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints string[]
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions string[]
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    access_key str
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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_automated_rotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iam_endpoint str
    Specifies a custom HTTP IAM endpoint to use.
    identity_token_audience str
    The audience claim value. Requires Vault 1.16+.
    identity_token_key str
    The key to use for signing identity tokens.
    identity_token_ttl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listing_visibility str
    Specifies whether to show this mount in the UI-specific listing endpoint
    local bool
    Specifies if the secret backend is local only
    max_lease_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
    path str
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    plugin_version str
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region str
    The AWS region to make API calls against. Defaults to us-east-1.
    role_arn str
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotation_period int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotation_schedule str
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    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. Requires Vault Enterprise 1.19+.
    seal_wrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secret_key str
    The AWS Secret Access Key to use when generating new credentials.
    sts_endpoint str
    Specifies a custom HTTP STS endpoint to use.
    sts_fallback_endpoints Sequence[str]
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    sts_fallback_regions Sequence[str]
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    sts_region str
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    username_template str
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey String
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    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.
    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.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint String
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience String
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey String
    The key to use for signing identity tokens.
    identityTokenTtl Number
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility String
    Specifies whether to show this mount in the UI-specific listing endpoint
    local Boolean
    Specifies if the secret backend is local only
    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
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion String
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region String
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn String
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod Number
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule String
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap Boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey String
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint String
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints List<String>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions List<String>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion String
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate String
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    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,
        access_key: Optional[str] = None,
        accessor: Optional[str] = None,
        allowed_managed_keys: Optional[Sequence[str]] = None,
        allowed_response_headers: Optional[Sequence[str]] = None,
        audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
        audit_non_hmac_response_keys: Optional[Sequence[str]] = None,
        default_lease_ttl_seconds: Optional[int] = None,
        delegated_auth_accessors: Optional[Sequence[str]] = None,
        description: Optional[str] = None,
        disable_automated_rotation: Optional[bool] = None,
        disable_remount: Optional[bool] = None,
        external_entropy_access: Optional[bool] = None,
        force_no_cache: Optional[bool] = None,
        iam_endpoint: Optional[str] = None,
        identity_token_audience: Optional[str] = None,
        identity_token_key: Optional[str] = None,
        identity_token_ttl: Optional[int] = None,
        listing_visibility: Optional[str] = None,
        local: Optional[bool] = None,
        max_lease_ttl_seconds: Optional[int] = None,
        namespace: Optional[str] = None,
        options: Optional[Mapping[str, str]] = None,
        passthrough_request_headers: Optional[Sequence[str]] = None,
        path: Optional[str] = None,
        plugin_version: Optional[str] = None,
        region: Optional[str] = None,
        role_arn: Optional[str] = None,
        rotation_period: Optional[int] = None,
        rotation_schedule: Optional[str] = None,
        rotation_window: Optional[int] = None,
        seal_wrap: Optional[bool] = None,
        secret_key: Optional[str] = None,
        sts_endpoint: Optional[str] = None,
        sts_fallback_endpoints: Optional[Sequence[str]] = None,
        sts_fallback_regions: Optional[Sequence[str]] = None,
        sts_region: Optional[str] = None,
        username_template: 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:aws: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:
    AccessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    Accessor string
    Accessor of the mount
    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.
    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.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    IamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    IdentityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    IdentityTokenKey string
    The key to use for signing identity tokens.
    IdentityTokenTtl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    ListingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    Local bool
    Specifies if the secret backend is local only
    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
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    PluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    Region string
    The AWS region to make API calls against. Defaults to us-east-1.
    RoleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    RotationPeriod int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    RotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    RotationWindow 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. Requires Vault Enterprise 1.19+.
    SealWrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    SecretKey string
    The AWS Secret Access Key to use when generating new credentials.
    StsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    StsFallbackEndpoints List<string>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    StsFallbackRegions List<string>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    StsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    UsernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    AccessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    Accessor string
    Accessor of the mount
    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.
    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.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    IamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    IdentityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    IdentityTokenKey string
    The key to use for signing identity tokens.
    IdentityTokenTtl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    ListingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    Local bool
    Specifies if the secret backend is local only
    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
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    PluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    Region string
    The AWS region to make API calls against. Defaults to us-east-1.
    RoleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    RotationPeriod int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    RotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    RotationWindow 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. Requires Vault Enterprise 1.19+.
    SealWrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    SecretKey string
    The AWS Secret Access Key to use when generating new credentials.
    StsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    StsFallbackEndpoints []string
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    StsFallbackRegions []string
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    StsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    UsernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey String
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    accessor String
    Accessor of the mount
    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.
    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.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint String
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience String
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey String
    The key to use for signing identity tokens.
    identityTokenTtl Integer
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility String
    Specifies whether to show this mount in the UI-specific listing endpoint
    local Boolean
    Specifies if the secret backend is local only
    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
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion String
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region String
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn String
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod Integer
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule String
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap Boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey String
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint String
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints List<String>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions List<String>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion String
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate String
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey string
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    accessor string
    Accessor of the mount
    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.
    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.
    disableAutomatedRotation boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint string
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience string
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey string
    The key to use for signing identity tokens.
    identityTokenTtl number
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility string
    Specifies whether to show this mount in the UI-specific listing endpoint
    local boolean
    Specifies if the secret backend is local only
    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
    path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion string
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region string
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn string
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod number
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule string
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey string
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint string
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints string[]
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions string[]
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion string
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate string
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    access_key str
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    accessor str
    Accessor of the mount
    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.
    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_automated_rotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iam_endpoint str
    Specifies a custom HTTP IAM endpoint to use.
    identity_token_audience str
    The audience claim value. Requires Vault 1.16+.
    identity_token_key str
    The key to use for signing identity tokens.
    identity_token_ttl int
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listing_visibility str
    Specifies whether to show this mount in the UI-specific listing endpoint
    local bool
    Specifies if the secret backend is local only
    max_lease_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
    path str
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    plugin_version str
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region str
    The AWS region to make API calls against. Defaults to us-east-1.
    role_arn str
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotation_period int
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotation_schedule str
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    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. Requires Vault Enterprise 1.19+.
    seal_wrap bool
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secret_key str
    The AWS Secret Access Key to use when generating new credentials.
    sts_endpoint str
    Specifies a custom HTTP STS endpoint to use.
    sts_fallback_endpoints Sequence[str]
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    sts_fallback_regions Sequence[str]
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    sts_region str
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    username_template str
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    accessKey String
    The AWS Access Key ID this backend should use to issue new credentials. Vault uses the official AWS SDK to authenticate, and thus can also use standard AWS environment credentials, shared file credentials or IAM role/ECS task credentials.
    accessor String
    Accessor of the mount
    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.
    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.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+.
    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.
    iamEndpoint String
    Specifies a custom HTTP IAM endpoint to use.
    identityTokenAudience String
    The audience claim value. Requires Vault 1.16+.
    identityTokenKey String
    The key to use for signing identity tokens.
    identityTokenTtl Number
    The TTL of generated identity tokens in seconds. Requires Vault 1.16+.
    listingVisibility String
    Specifies whether to show this mount in the UI-specific listing endpoint
    local Boolean
    Specifies if the secret backend is local only
    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
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to aws.
    pluginVersion String
    Specifies the semantic version of the plugin to use, e.g. 'v1.0.0'
    region String
    The AWS region to make API calls against. Defaults to us-east-1.
    roleArn String
    Role ARN to assume for plugin identity token federation. Requires Vault 1.16+.
    rotationPeriod Number
    The amount of time in seconds Vault should wait before rotating the root credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+.
    rotationSchedule String
    The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+.
    rotationWindow 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. Requires Vault Enterprise 1.19+.
    sealWrap Boolean
    Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
    secretKey String
    The AWS Secret Access Key to use when generating new credentials.
    stsEndpoint String
    Specifies a custom HTTP STS endpoint to use.
    stsFallbackEndpoints List<String>
    Ordered list of sts_endpoints to try if the defined one fails. Requires Vault 1.19+
    stsFallbackRegions List<String>
    Ordered list of sts_regions matching the fallback endpoints. Should correspond in order with those endpoints. Requires Vault 1.19+
    stsRegion String
    Specifies the region of the STS endpoint. Should be included if sts_endpoint is supplied. Requires Vault 1.19+
    usernameTemplate String
    Template describing how dynamic usernames are generated. The username template is used to generate both IAM usernames (capped at 64 characters) and STS usernames (capped at 32 characters). If no template is provided the field defaults to the template:

    {{ if (eq .Type "STS") }}
{{ printf "vault-%s-%s" (unix_time) (random 20) | truncate 32 }}
{{ else }}
{{ printf "vault-%s-%s-%s" (printf "%s-%s" (.DisplayName) (.PolicyName) | truncate 42) (unix_time) (random 20) | truncate 64 }}
{{ end }}

    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.2.0 published on Tuesday, Aug 19, 2025 by Pulumi
    pulumi/pulumi-vault