Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. HashiCorp Vault Provider
  3. API Docs
  4. gcp
  5. SecretBackend
HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-vault

vault.gcp.SecretBackend

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
pulumi/pulumi-vault

    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/v6/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/v6/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

    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,
                  credentials: Optional[str] = None,
                  default_lease_ttl_seconds: Optional[int] = None,
                  description: Optional[str] = None,
                  disable_automated_rotation: Optional[bool] = None,
                  disable_remount: Optional[bool] = None,
                  identity_token_audience: Optional[str] = None,
                  identity_token_key: Optional[str] = None,
                  identity_token_ttl: Optional[int] = None,
                  local: Optional[bool] = None,
                  max_lease_ttl_seconds: Optional[int] = None,
                  namespace: Optional[str] = None,
                  path: Optional[str] = None,
                  rotation_period: Optional[int] = None,
                  rotation_schedule: Optional[str] = None,
                  rotation_window: Optional[int] = 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()
{
    Credentials = "string",
    DefaultLeaseTtlSeconds = 0,
    Description = "string",
    DisableAutomatedRotation = false,
    DisableRemount = false,
    IdentityTokenAudience = "string",
    IdentityTokenKey = "string",
    IdentityTokenTtl = 0,
    Local = false,
    MaxLeaseTtlSeconds = 0,
    Namespace = "string",
    Path = "string",
    RotationPeriod = 0,
    RotationSchedule = "string",
    RotationWindow = 0,
    ServiceAccountEmail = "string",
});

    example, err := gcp.NewSecretBackend(ctx, "examplesecretBackendResourceResourceFromGcpsecretBackend", &gcp.SecretBackendArgs{
	Credentials:              pulumi.String("string"),
	DefaultLeaseTtlSeconds:   pulumi.Int(0),
	Description:              pulumi.String("string"),
	DisableAutomatedRotation: pulumi.Bool(false),
	DisableRemount:           pulumi.Bool(false),
	IdentityTokenAudience:    pulumi.String("string"),
	IdentityTokenKey:         pulumi.String("string"),
	IdentityTokenTtl:         pulumi.Int(0),
	Local:                    pulumi.Bool(false),
	MaxLeaseTtlSeconds:       pulumi.Int(0),
	Namespace:                pulumi.String("string"),
	Path:                     pulumi.String("string"),
	RotationPeriod:           pulumi.Int(0),
	RotationSchedule:         pulumi.String("string"),
	RotationWindow:           pulumi.Int(0),
	ServiceAccountEmail:      pulumi.String("string"),
})

    var examplesecretBackendResourceResourceFromGcpsecretBackend = new com.pulumi.vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend", com.pulumi.vault.gcp.SecretBackendArgs.builder()
    .credentials("string")
    .defaultLeaseTtlSeconds(0)
    .description("string")
    .disableAutomatedRotation(false)
    .disableRemount(false)
    .identityTokenAudience("string")
    .identityTokenKey("string")
    .identityTokenTtl(0)
    .local(false)
    .maxLeaseTtlSeconds(0)
    .namespace("string")
    .path("string")
    .rotationPeriod(0)
    .rotationSchedule("string")
    .rotationWindow(0)
    .serviceAccountEmail("string")
    .build());

    examplesecret_backend_resource_resource_from_gcpsecret_backend = vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend",
    credentials="string",
    default_lease_ttl_seconds=0,
    description="string",
    disable_automated_rotation=False,
    disable_remount=False,
    identity_token_audience="string",
    identity_token_key="string",
    identity_token_ttl=0,
    local=False,
    max_lease_ttl_seconds=0,
    namespace="string",
    path="string",
    rotation_period=0,
    rotation_schedule="string",
    rotation_window=0,
    service_account_email="string")

    const examplesecretBackendResourceResourceFromGcpsecretBackend = new vault.gcp.SecretBackend("examplesecretBackendResourceResourceFromGcpsecretBackend", {
    credentials: "string",
    defaultLeaseTtlSeconds: 0,
    description: "string",
    disableAutomatedRotation: false,
    disableRemount: false,
    identityTokenAudience: "string",
    identityTokenKey: "string",
    identityTokenTtl: 0,
    local: false,
    maxLeaseTtlSeconds: 0,
    namespace: "string",
    path: "string",
    rotationPeriod: 0,
    rotationSchedule: "string",
    rotationWindow: 0,
    serviceAccountEmail: "string",
});

    type: vault:gcp:SecretBackend
properties:
    credentials: string
    defaultLeaseTtlSeconds: 0
    description: string
    disableAutomatedRotation: false
    disableRemount: false
    identityTokenAudience: string
    identityTokenKey: string
    identityTokenTtl: 0
    local: false
    maxLeaseTtlSeconds: 0
    namespace: string
    path: string
    rotationPeriod: 0
    rotationSchedule: string
    rotationWindow: 0
    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:

    Credentials string
    JSON-encoded credentials to use to connect to GCP
    DefaultLeaseTtlSeconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    Description string
    A human-friendly description for this backend.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    IdentityTokenAudience string
    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.
    IdentityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    IdentityTokenTtl int
    The TTL of generated tokens.
    Local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    MaxLeaseTtlSeconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    ServiceAccountEmail string
    Service Account to impersonate for plugin workload identity federation. Required with identity_token_audience. Requires Vault 1.17+. Available only for Vault Enterprise.
    Credentials string
    JSON-encoded credentials to use to connect to GCP
    DefaultLeaseTtlSeconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    Description string
    A human-friendly description for this backend.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    IdentityTokenAudience string
    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.
    IdentityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    IdentityTokenTtl int
    The TTL of generated tokens.
    Local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    MaxLeaseTtlSeconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    ServiceAccountEmail string
    Service Account to impersonate for plugin workload identity federation. Required with identity_token_audience. Requires Vault 1.17+. Available only for Vault Enterprise.
    credentials String
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds Integer
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description String
    A human-friendly description for this backend.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience String
    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.
    identityTokenKey String
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl Integer
    The TTL of generated tokens.
    local Boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds Integer
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail String
    Service Account to impersonate for plugin workload identity federation. Required with identity_token_audience. Requires Vault 1.17+. Available only for Vault Enterprise.
    credentials string
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds number
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description string
    A human-friendly description for this backend.
    disableAutomatedRotation boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience string
    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.
    identityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl number
    The TTL of generated tokens.
    local boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds number
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail string
    Service Account to impersonate for plugin workload identity federation. Required with identity_token_audience. Requires Vault 1.17+. Available only for Vault Enterprise.
    credentials str
    JSON-encoded credentials to use to connect to GCP
    default_lease_ttl_seconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description str
    A human-friendly description for this backend.
    disable_automated_rotation bool
    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
    identity_token_audience str
    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_key str
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identity_token_ttl int
    The TTL of generated tokens.
    local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    max_lease_ttl_seconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path str
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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.
    service_account_email str
    Service Account to impersonate for plugin workload identity federation. Required with identity_token_audience. Requires Vault 1.17+. Available only for Vault Enterprise.
    credentials String
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds Number
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description String
    A human-friendly description for this backend.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience String
    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.
    identityTokenKey String
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl Number
    The TTL of generated tokens.
    local Boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds Number
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail String
    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:

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

    Look up Existing SecretBackend Resource

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

    public static get(name: string, id: Input<ID>, state?: SecretBackendState, opts?: CustomResourceOptions): SecretBackend
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        accessor: Optional[str] = None,
        credentials: Optional[str] = None,
        default_lease_ttl_seconds: Optional[int] = None,
        description: Optional[str] = None,
        disable_automated_rotation: Optional[bool] = None,
        disable_remount: Optional[bool] = None,
        identity_token_audience: Optional[str] = None,
        identity_token_key: Optional[str] = None,
        identity_token_ttl: Optional[int] = None,
        local: Optional[bool] = None,
        max_lease_ttl_seconds: Optional[int] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None,
        rotation_period: Optional[int] = None,
        rotation_schedule: Optional[str] = None,
        rotation_window: Optional[int] = 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.
    The following state arguments are supported:
    Accessor string
    The accessor of the created GCP mount.
    Credentials string
    JSON-encoded credentials to use to connect to GCP
    DefaultLeaseTtlSeconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    Description string
    A human-friendly description for this backend.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    IdentityTokenAudience string
    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.
    IdentityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    IdentityTokenTtl int
    The TTL of generated tokens.
    Local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    MaxLeaseTtlSeconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    ServiceAccountEmail string
    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.
    Credentials string
    JSON-encoded credentials to use to connect to GCP
    DefaultLeaseTtlSeconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    Description string
    A human-friendly description for this backend.
    DisableAutomatedRotation bool
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    DisableRemount bool
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    IdentityTokenAudience string
    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.
    IdentityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    IdentityTokenTtl int
    The TTL of generated tokens.
    Local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    MaxLeaseTtlSeconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    Path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    ServiceAccountEmail string
    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.
    credentials String
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds Integer
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description String
    A human-friendly description for this backend.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience String
    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.
    identityTokenKey String
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl Integer
    The TTL of generated tokens.
    local Boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds Integer
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail String
    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.
    credentials string
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds number
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description string
    A human-friendly description for this backend.
    disableAutomatedRotation boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience string
    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.
    identityTokenKey string
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl number
    The TTL of generated tokens.
    local boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds number
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path string
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail string
    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.
    credentials str
    JSON-encoded credentials to use to connect to GCP
    default_lease_ttl_seconds int
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description str
    A human-friendly description for this backend.
    disable_automated_rotation bool
    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
    identity_token_audience str
    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_key str
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identity_token_ttl int
    The TTL of generated tokens.
    local bool
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    max_lease_ttl_seconds int
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path str
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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.
    service_account_email str
    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.
    credentials String
    JSON-encoded credentials to use to connect to GCP
    defaultLeaseTtlSeconds Number
    The default TTL for credentials issued by this backend. Defaults to '0'.
    description String
    A human-friendly description for this backend.
    disableAutomatedRotation Boolean
    Cancels all upcoming rotations of the root credential until unset. Requires Vault Enterprise 1.19+. Available only for Vault Enterprise.
    disableRemount Boolean
    If set, opts out of mount migration on path updates. See here for more info on Mount Migration
    identityTokenAudience String
    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.
    identityTokenKey String
    The key to use for signing plugin identity tokens. Requires Vault 1.17+. Available only for Vault Enterprise.
    identityTokenTtl Number
    The TTL of generated tokens.
    local Boolean
    Boolean flag that can be explicitly set to true to enforce local mount in HA environment
    maxLeaseTtlSeconds Number
    The maximum TTL that can be requested for credentials issued by this backend. Defaults to '0'.
    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.
    path String
    The unique path this backend should be mounted at. Must not begin or end with a /. Defaults to gcp.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    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+. Available only for Vault Enterprise.
    serviceAccountEmail String
    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.
    vault logo
    HashiCorp Vault v6.7.1 published on Friday, May 2, 2025 by Pulumi
    pulumi/pulumi-vault