vault.gcp.SecretBackend
Explore with Pulumi AI
Example Usage
You can setup the GCP secret backend with Workload Identity Federation (WIF) for a secret-less configuration:
import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const gcp = new vault.gcp.SecretBackend("gcp", {
identityTokenKey: "example-key",
identityTokenTtl: 1800,
identityTokenAudience: "<TOKEN_AUDIENCE>",
serviceAccountEmail: "<SERVICE_ACCOUNT_EMAIL>",
rotationSchedule: "0 * * * SAT",
rotationWindow: 3600,
});
import pulumi
import pulumi_vault as vault
gcp = vault.gcp.SecretBackend("gcp",
identity_token_key="example-key",
identity_token_ttl=1800,
identity_token_audience="<TOKEN_AUDIENCE>",
service_account_email="<SERVICE_ACCOUNT_EMAIL>",
rotation_schedule="0 * * * SAT",
rotation_window=3600)
package main
import (
"github.com/pulumi/pulumi-vault/sdk/v7/go/vault/gcp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := gcp.NewSecretBackend(ctx, "gcp", &gcp.SecretBackendArgs{
IdentityTokenKey: pulumi.String("example-key"),
IdentityTokenTtl: pulumi.Int(1800),
IdentityTokenAudience: pulumi.String("<TOKEN_AUDIENCE>"),
ServiceAccountEmail: pulumi.String("<SERVICE_ACCOUNT_EMAIL>"),
RotationSchedule: pulumi.String("0 * * * SAT"),
RotationWindow: pulumi.Int(3600),
})
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 gcp = new Vault.Gcp.SecretBackend("gcp", new()
{
IdentityTokenKey = "example-key",
IdentityTokenTtl = 1800,
IdentityTokenAudience = "<TOKEN_AUDIENCE>",
ServiceAccountEmail = "<SERVICE_ACCOUNT_EMAIL>",
RotationSchedule = "0 * * * SAT",
RotationWindow = 3600,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.gcp.SecretBackend;
import com.pulumi.vault.gcp.SecretBackendArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var gcp = new SecretBackend("gcp", SecretBackendArgs.builder()
.identityTokenKey("example-key")
.identityTokenTtl(1800)
.identityTokenAudience("<TOKEN_AUDIENCE>")
.serviceAccountEmail("<SERVICE_ACCOUNT_EMAIL>")
.rotationSchedule("0 * * * SAT")
.rotationWindow(3600)
.build());
}
}
resources:
gcp:
type: vault:gcp:SecretBackend
properties:
identityTokenKey: example-key
identityTokenTtl: 1800
identityTokenAudience: <TOKEN_AUDIENCE>
serviceAccountEmail: <SERVICE_ACCOUNT_EMAIL>
rotationSchedule: 0 * * * SAT
rotationWindow: 3600
import * as pulumi from "@pulumi/pulumi";
import * as std from "@pulumi/std";
import * as vault from "@pulumi/vault";
const gcp = new vault.gcp.SecretBackend("gcp", {
credentials: std.file({
input: "credentials.json",
}).then(invoke => invoke.result),
rotationSchedule: "0 * * * SAT",
rotationWindow: 3600,
});
import pulumi
import pulumi_std as std
import pulumi_vault as vault
gcp = vault.gcp.SecretBackend("gcp",
credentials=std.file(input="credentials.json").result,
rotation_schedule="0 * * * SAT",
rotation_window=3600)
package main
import (
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi-vault/sdk/v7/go/vault/gcp"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeFile, err := std.File(ctx, &std.FileArgs{
Input: "credentials.json",
}, nil)
if err != nil {
return err
}
_, err = gcp.NewSecretBackend(ctx, "gcp", &gcp.SecretBackendArgs{
Credentials: pulumi.String(invokeFile.Result),
RotationSchedule: pulumi.String("0 * * * SAT"),
RotationWindow: pulumi.Int(3600),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Std = Pulumi.Std;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
var gcp = new Vault.Gcp.SecretBackend("gcp", new()
{
Credentials = Std.File.Invoke(new()
{
Input = "credentials.json",
}).Apply(invoke => invoke.Result),
RotationSchedule = "0 * * * SAT",
RotationWindow = 3600,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.gcp.SecretBackend;
import com.pulumi.vault.gcp.SecretBackendArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var gcp = new SecretBackend("gcp", SecretBackendArgs.builder()
.credentials(StdFunctions.file(FileArgs.builder()
.input("credentials.json")
.build()).result())
.rotationSchedule("0 * * * SAT")
.rotationWindow(3600)
.build());
}
}
resources:
gcp:
type: vault:gcp:SecretBackend
properties:
credentials:
fn::invoke:
function: std:file
arguments:
input: credentials.json
return: result
rotationSchedule: 0 * * * SAT
rotationWindow: 3600
Ephemeral Attributes Reference
The following write-only attributes are supported:
credentials_wo
- (Optional) The GCP service account credentials in JSON format. Can be updated. Note: This property is write-only and will not be read from the API.
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,
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,
credentials: Optional[str] = None,
credentials_wo_version: Optional[int] = 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,
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,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
seal_wrap: Optional[bool] = None,
service_account_email: 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:gcp: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 examplesecretBackendResourceResourceFromGcpsecretBackend = new Vault.Gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend", new()
{
AllowedManagedKeys = new[]
{
"string",
},
AllowedResponseHeaders = new[]
{
"string",
},
AuditNonHmacRequestKeys = new[]
{
"string",
},
AuditNonHmacResponseKeys = new[]
{
"string",
},
Credentials = "string",
CredentialsWoVersion = 0,
DefaultLeaseTtlSeconds = 0,
DelegatedAuthAccessors = new[]
{
"string",
},
Description = "string",
DisableAutomatedRotation = false,
DisableRemount = false,
ExternalEntropyAccess = false,
ForceNoCache = false,
IdentityTokenAudience = "string",
IdentityTokenKey = "string",
IdentityTokenTtl = 0,
ListingVisibility = "string",
Local = false,
MaxLeaseTtlSeconds = 0,
Namespace = "string",
Options =
{
{ "string", "string" },
},
PassthroughRequestHeaders = new[]
{
"string",
},
Path = "string",
PluginVersion = "string",
RotationPeriod = 0,
RotationSchedule = "string",
RotationWindow = 0,
SealWrap = false,
ServiceAccountEmail = "string",
});
example, err := gcp.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromGcpsecretBackend", &gcp.SecretBackendArgs{
AllowedManagedKeys: pulumi.StringArray{
pulumi.String("string"),
},
AllowedResponseHeaders: pulumi.StringArray{
pulumi.String("string"),
},
AuditNonHmacRequestKeys: pulumi.StringArray{
pulumi.String("string"),
},
AuditNonHmacResponseKeys: pulumi.StringArray{
pulumi.String("string"),
},
Credentials: pulumi.String("string"),
CredentialsWoVersion: pulumi.Int(0),
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),
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"),
RotationPeriod: pulumi.Int(0),
RotationSchedule: pulumi.String("string"),
RotationWindow: pulumi.Int(0),
SealWrap: pulumi.Bool(false),
ServiceAccountEmail: pulumi.String("string"),
})
var examplesecretBackendResourceResourceFromGcpsecretBackend = new com.pulumi.vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend", com.pulumi.vault.gcp.SecretBackendArgs.builder()
.allowedManagedKeys("string")
.allowedResponseHeaders("string")
.auditNonHmacRequestKeys("string")
.auditNonHmacResponseKeys("string")
.credentials("string")
.credentialsWoVersion(0)
.defaultLeaseTtlSeconds(0)
.delegatedAuthAccessors("string")
.description("string")
.disableAutomatedRotation(false)
.disableRemount(false)
.externalEntropyAccess(false)
.forceNoCache(false)
.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")
.rotationPeriod(0)
.rotationSchedule("string")
.rotationWindow(0)
.sealWrap(false)
.serviceAccountEmail("string")
.build());
examplesecret_backend_resource_resource_from_gcpsecret_backend = vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend",
allowed_managed_keys=["string"],
allowed_response_headers=["string"],
audit_non_hmac_request_keys=["string"],
audit_non_hmac_response_keys=["string"],
credentials="string",
credentials_wo_version=0,
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,
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",
rotation_period=0,
rotation_schedule="string",
rotation_window=0,
seal_wrap=False,
service_account_email="string")
const examplesecretBackendResourceResourceFromGcpsecretBackend = new vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend", {
allowedManagedKeys: ["string"],
allowedResponseHeaders: ["string"],
auditNonHmacRequestKeys: ["string"],
auditNonHmacResponseKeys: ["string"],
credentials: "string",
credentialsWoVersion: 0,
defaultLeaseTtlSeconds: 0,
delegatedAuthAccessors: ["string"],
description: "string",
disableAutomatedRotation: false,
disableRemount: false,
externalEntropyAccess: false,
forceNoCache: false,
identityTokenAudience: "string",
identityTokenKey: "string",
identityTokenTtl: 0,
listingVisibility: "string",
local: false,
maxLeaseTtlSeconds: 0,
namespace: "string",
options: {
string: "string",
},
passthroughRequestHeaders: ["string"],
path: "string",
pluginVersion: "string",
rotationPeriod: 0,
rotationSchedule: "string",
rotationWindow: 0,
sealWrap: false,
serviceAccountEmail: "string",
});
type: vault:gcp:SecretBackend
properties:
allowedManagedKeys:
- string
allowedResponseHeaders:
- string
auditNonHmacRequestKeys:
- string
auditNonHmacResponseKeys:
- string
credentials: string
credentialsWoVersion: 0
defaultLeaseTtlSeconds: 0
delegatedAuthAccessors:
- string
description: string
disableAutomatedRotation: false
disableRemount: false
externalEntropyAccess: false
forceNoCache: false
identityTokenAudience: string
identityTokenKey: string
identityTokenTtl: 0
listingVisibility: string
local: false
maxLeaseTtlSeconds: 0
namespace: string
options:
string: string
passthroughRequestHeaders:
- string
path: string
pluginVersion: string
rotationPeriod: 0
rotationSchedule: string
rotationWindow: 0
sealWrap: false
serviceAccountEmail: 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:
- 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.
- Credentials string
- JSON-encoded credentials to use to connect to GCP
- Credentials
Wo intVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - Identity
Token stringKey - The key to use for signing identity tokens.
- Identity
Token intTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - Options Dictionary<string, string>
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- 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.
- Credentials string
- JSON-encoded credentials to use to connect to GCP
- Credentials
Wo intVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - Identity
Token stringKey - The key to use for signing identity tokens.
- Identity
Token intTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - Options map[string]string
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- 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.
- credentials String
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo IntegerVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token StringKey - The key to use for signing identity tokens.
- identity
Token IntegerTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Map<String,String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account StringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- 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.
- credentials string
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo numberVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token stringKey - The key to use for signing identity tokens.
- identity
Token numberTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options {[key: string]: string}
- Specifies mount type specific options that are passed to the backend
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- 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.
- credentials str
- JSON-encoded credentials to use to connect to GCP
- credentials_
wo_ intversion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ straudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity_
token_ strkey - The key to use for signing identity tokens.
- identity_
token_ intttl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Mapping[str, str]
- Specifies mount type specific options that are passed to the backend
- passthrough_
request_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- path str
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - seal_
wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service_
account_ stremail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- 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.
- credentials String
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo NumberVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token StringKey - The key to use for signing identity tokens.
- identity
Token NumberTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Map<String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account StringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
Outputs
All input properties are implicitly available as output properties. Additionally, the SecretBackend resource produces the following output properties:
Look up Existing SecretBackend Resource
Get an existing SecretBackend resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
accessor: Optional[str] = None,
allowed_managed_keys: Optional[Sequence[str]] = None,
allowed_response_headers: Optional[Sequence[str]] = None,
audit_non_hmac_request_keys: Optional[Sequence[str]] = None,
audit_non_hmac_response_keys: Optional[Sequence[str]] = None,
credentials: Optional[str] = None,
credentials_wo_version: Optional[int] = 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,
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,
rotation_period: Optional[int] = None,
rotation_schedule: Optional[str] = None,
rotation_window: Optional[int] = None,
seal_wrap: Optional[bool] = None,
service_account_email: 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:gcp:SecretBackend get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Accessor string
- The accessor of the created GCP mount.
- 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.
- Credentials string
- JSON-encoded credentials to use to connect to GCP
- Credentials
Wo intVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - Identity
Token stringKey - The key to use for signing identity tokens.
- Identity
Token intTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - Options Dictionary<string, string>
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request List<string>Headers - List of headers to allow and pass from the request to the plugin
- Path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- Accessor string
- The accessor of the created GCP mount.
- 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.
- Credentials string
- JSON-encoded credentials to use to connect to GCP
- Credentials
Wo intVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Disable
Remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- External
Entropy boolAccess - Enable the secrets engine to access Vault's external entropy source
- Force
No boolCache - If set to true, disables caching.
- Identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - Identity
Token stringKey - The key to use for signing identity tokens.
- Identity
Token intTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - Options map[string]string
- Specifies mount type specific options that are passed to the backend
- Passthrough
Request []stringHeaders - List of headers to allow and pass from the request to the plugin
- Path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- Rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - Seal
Wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- Service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- accessor String
- The accessor of the created GCP mount.
- 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.
- credentials String
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo IntegerVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token StringKey - The key to use for signing identity tokens.
- identity
Token IntegerTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Map<String,String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account StringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- accessor string
- The accessor of the created GCP mount.
- 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.
- credentials string
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo numberVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy booleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No booleanCache - If set to true, disables caching.
- identity
Token stringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token stringKey - The key to use for signing identity tokens.
- identity
Token numberTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options {[key: string]: string}
- Specifies mount type specific options that are passed to the backend
- passthrough
Request string[]Headers - List of headers to allow and pass from the request to the plugin
- path string
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule string - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account stringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- accessor str
- The accessor of the created GCP mount.
- allowed_
managed_ Sequence[str]keys - List of managed key registry entry names that the mount in question is allowed to access
- allowed_
response_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- audit_
non_ Sequence[str]hmac_ request_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the request data object.
- audit_
non_ Sequence[str]hmac_ response_ keys - Specifies the list of keys that will not be HMAC'd by audit devices in the response data object.
- credentials str
- JSON-encoded credentials to use to connect to GCP
- credentials_
wo_ intversion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable_
remount bool - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external_
entropy_ boolaccess - Enable the secrets engine to access Vault's external entropy source
- force_
no_ boolcache - If set to true, disables caching.
- identity_
token_ straudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity_
token_ strkey - The key to use for signing identity tokens.
- identity_
token_ intttl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Mapping[str, str]
- Specifies mount type specific options that are passed to the backend
- passthrough_
request_ Sequence[str]headers - List of headers to allow and pass from the request to the plugin
- path str
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise.
- 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+. Available only for Vault Enterprise. - seal_
wrap bool - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service_
account_ stremail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
- accessor String
- The accessor of the created GCP mount.
- 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.
- credentials String
- JSON-encoded credentials to use to connect to GCP
- credentials
Wo NumberVersion - The version of the
credentials_wo
. For more info see updating write-only attributes. - 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 credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- disable
Remount Boolean - If set, opts out of mount migration on path updates. See here for more info on Mount Migration
- external
Entropy BooleanAccess - Enable the secrets engine to access Vault's external entropy source
- force
No BooleanCache - If set to true, disables caching.
- identity
Token StringAudience - The audience claim value for plugin identity
tokens. Must match an allowed audience configured for the target Workload Identity Pool.
Mutually exclusive with
credentials
. Requires Vault 1.17+. Available only for Vault Enterprise. - identity
Token StringKey - The key to use for signing identity tokens.
- identity
Token NumberTtl - The TTL of generated 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
namespace
is always relative to the provider's configured namespace. Available only for Vault Enterprise. - options Map<String>
- Specifies mount type specific options that are passed to the backend
- passthrough
Request List<String>Headers - List of headers to allow and pass from the request to the plugin
- path String
- The unique path this backend should be mounted at. Must
not begin or end with a
/
. Defaults togcp
. - 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 credential. A zero value tells Vault not to rotate the root credential. The minimum rotation period is 10 seconds. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- rotation
Schedule String - The schedule, in cron-style time format, defining the schedule on which Vault should rotate the root token. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
- 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
. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise. - seal
Wrap Boolean - Enable seal wrapping for the mount, causing values stored by the mount to be wrapped by the seal's encryption capability
- service
Account StringEmail - Service Account to impersonate for plugin workload identity federation.
Required with
identity_token_audience
. Requires Vault 1.17+. Available only for Vault Enterprise.
Package Details
- Repository
- Vault pulumi/pulumi-vault
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vault
Terraform Provider.