1. Registry
  2. Packages
  3. HashiCorp Vault Provider
  4. API Docs
  5. transform
  6. TransformationTokenization
Viewing docs for HashiCorp Vault v7.13.0
published on Friday, Sep 18, 2026 by Pulumi
vault logo vault logo
Viewing docs for HashiCorp Vault v7.13.0
published on Friday, Sep 18, 2026 by Pulumi

    This resource supports the “/transform/transformations/tokenization/{name}” Vault endpoint.

    If a tokenization transformation with the given name doesn’t exist, it will be created. If a tokenization transformation with the given name exists, it will be updated with the new attributes.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vault from "@pulumi/vault";
    
    const example = new vault.Mount("example", {
        path: "transform",
        type: "transform",
    });
    const exampleTransformationTokenization = new vault.transform.TransformationTokenization("example", {
        path: example.path,
        name: "tkn-example",
        maxTtl: 86400,
        deletionAllowed: true,
        mappingMode: "default",
        allowedRoles: ["payments"],
    });
    
    import pulumi
    import pulumi_vault as vault
    
    example = vault.Mount("example",
        path="transform",
        type="transform")
    example_transformation_tokenization = vault.transform.TransformationTokenization("example",
        path=example.path,
        name="tkn-example",
        max_ttl=86400,
        deletion_allowed=True,
        mapping_mode="default",
        allowed_roles=["payments"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v7/go/vault"
    	"github.com/pulumi/pulumi-vault/sdk/v7/go/vault/transform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := vault.NewMount(ctx, "example", &vault.MountArgs{
    			Path: pulumi.String("transform"),
    			Type: pulumi.String("transform"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = transform.NewTransformationTokenization(ctx, "example", &transform.TransformationTokenizationArgs{
    			Path:            example.Path,
    			Name:            pulumi.String("tkn-example"),
    			MaxTtl:          pulumi.Int(86400),
    			DeletionAllowed: pulumi.Bool(true),
    			MappingMode:     pulumi.String("default"),
    			AllowedRoles: pulumi.StringArray{
    				pulumi.String("payments"),
    			},
    		})
    		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 example = new Vault.Mount("example", new()
        {
            Path = "transform",
            Type = "transform",
        });
    
        var exampleTransformationTokenization = new Vault.Transform.TransformationTokenization("example", new()
        {
            Path = example.Path,
            Name = "tkn-example",
            MaxTtl = 86400,
            DeletionAllowed = true,
            MappingMode = "default",
            AllowedRoles = new[]
            {
                "payments",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vault.Mount;
    import com.pulumi.vault.MountArgs;
    import com.pulumi.vault.transform.TransformationTokenization;
    import com.pulumi.vault.transform.TransformationTokenizationArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Mount("example", MountArgs.builder()
                .path("transform")
                .type("transform")
                .build());
    
            var exampleTransformationTokenization = new TransformationTokenization("exampleTransformationTokenization", TransformationTokenizationArgs.builder()
                .path(example.path())
                .name("tkn-example")
                .maxTtl(86400)
                .deletionAllowed(true)
                .mappingMode("default")
                .allowedRoles("payments")
                .build());
    
        }
    }
    
    resources:
      example:
        type: vault:Mount
        properties:
          path: transform
          type: transform
      exampleTransformationTokenization:
        type: vault:transform:TransformationTokenization
        name: example
        properties:
          path: ${example.path}
          name: tkn-example
          maxTtl: 86400
          deletionAllowed: true
          mappingMode: default
          allowedRoles:
            - payments
    
    pulumi {
      required_providers {
        vault = {
          source = "pulumi/vault"
        }
      }
    }
    
    resource "vault_mount" "example" {
      path = "transform"
      type = "transform"
    }
    resource "vault_transform_transformationtokenization" "example" {
      path             = vault_mount.example.path
      name             = "tkn-example"
      max_ttl          = 86400
      deletion_allowed = true
      mapping_mode     = "default"
      allowed_roles    = ["payments"]
    }
    

    Create TransformationTokenization Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TransformationTokenization(name: string, args: TransformationTokenizationArgs, opts?: CustomResourceOptions);
    @overload
    def TransformationTokenization(resource_name: str,
                                   args: TransformationTokenizationArgs,
                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def TransformationTokenization(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   path: Optional[str] = None,
                                   allowed_roles: Optional[Sequence[str]] = None,
                                   convergent: Optional[bool] = None,
                                   deletion_allowed: Optional[bool] = None,
                                   mapping_mode: Optional[str] = None,
                                   max_ttl: Optional[int] = None,
                                   name: Optional[str] = None,
                                   namespace: Optional[str] = None,
                                   stores: Optional[Sequence[str]] = None)
    func NewTransformationTokenization(ctx *Context, name string, args TransformationTokenizationArgs, opts ...ResourceOption) (*TransformationTokenization, error)
    public TransformationTokenization(string name, TransformationTokenizationArgs args, CustomResourceOptions? opts = null)
    public TransformationTokenization(String name, TransformationTokenizationArgs args)
    public TransformationTokenization(String name, TransformationTokenizationArgs args, CustomResourceOptions options)
    
    type: vault:transform:TransformationTokenization
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "vault_transform_transformation_tokenization" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args TransformationTokenizationArgs
    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 TransformationTokenizationArgs
    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 TransformationTokenizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransformationTokenizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransformationTokenizationArgs
    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 transformationTokenizationResource = new Vault.Transform.TransformationTokenization("transformationTokenizationResource", new()
    {
        Path = "string",
        AllowedRoles = new[]
        {
            "string",
        },
        Convergent = false,
        DeletionAllowed = false,
        MappingMode = "string",
        MaxTtl = 0,
        Name = "string",
        Namespace = "string",
        Stores = new[]
        {
            "string",
        },
    });
    
    example, err := transform.NewTransformationTokenization(ctx, "transformationTokenizationResource", &transform.TransformationTokenizationArgs{
    	Path: pulumi.String("string"),
    	AllowedRoles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Convergent:      pulumi.Bool(false),
    	DeletionAllowed: pulumi.Bool(false),
    	MappingMode:     pulumi.String("string"),
    	MaxTtl:          pulumi.Int(0),
    	Name:            pulumi.String("string"),
    	Namespace:       pulumi.String("string"),
    	Stores: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    resource "vault_transform_transformation_tokenization" "transformationTokenizationResource" {
      lifecycle {
        create_before_destroy = true
      }
      path             = "string"
      allowed_roles    = ["string"]
      convergent       = false
      deletion_allowed = false
      mapping_mode     = "string"
      max_ttl          = 0
      name             = "string"
      namespace        = "string"
      stores           = ["string"]
    }
    
    var transformationTokenizationResource = new TransformationTokenization("transformationTokenizationResource", TransformationTokenizationArgs.builder()
        .path("string")
        .allowedRoles("string")
        .convergent(false)
        .deletionAllowed(false)
        .mappingMode("string")
        .maxTtl(0)
        .name("string")
        .namespace("string")
        .stores("string")
        .build());
    
    transformation_tokenization_resource = vault.transform.TransformationTokenization("transformationTokenizationResource",
        path="string",
        allowed_roles=["string"],
        convergent=False,
        deletion_allowed=False,
        mapping_mode="string",
        max_ttl=0,
        name="string",
        namespace="string",
        stores=["string"])
    
    const transformationTokenizationResource = new vault.transform.TransformationTokenization("transformationTokenizationResource", {
        path: "string",
        allowedRoles: ["string"],
        convergent: false,
        deletionAllowed: false,
        mappingMode: "string",
        maxTtl: 0,
        name: "string",
        namespace: "string",
        stores: ["string"],
    });
    
    type: vault:transform:TransformationTokenization
    properties:
        allowedRoles:
            - string
        convergent: false
        deletionAllowed: false
        mappingMode: string
        maxTtl: 0
        name: string
        namespace: string
        path: string
        stores:
            - string
    

    TransformationTokenization 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 TransformationTokenization resource accepts the following input properties:

    Path string
    Path to where the back-end is mounted within Vault.
    AllowedRoles List<string>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    Convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    MappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    MaxTtl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    Name string
    Name of the transformation to create/update.
    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.
    Stores List<string>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    Path string
    Path to where the back-end is mounted within Vault.
    AllowedRoles []string
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    Convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    MappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    MaxTtl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    Name string
    Name of the transformation to create/update.
    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.
    Stores []string
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    path string
    Path to where the back-end is mounted within Vault.
    allowed_roles list(string)
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mapping_mode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    max_ttl number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name string
    Name of the transformation to create/update.
    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.
    stores list(string)
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    path String
    Path to where the back-end is mounted within Vault.
    allowedRoles List<String>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent Boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode String
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl Integer
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name String
    Name of the transformation to create/update.
    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.
    stores List<String>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    path string
    Path to where the back-end is mounted within Vault.
    allowedRoles string[]
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name string
    Name of the transformation to create/update.
    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.
    stores string[]
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    path str
    Path to where the back-end is mounted within Vault.
    allowed_roles Sequence[str]
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mapping_mode str
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    max_ttl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name str
    Name of the transformation to create/update.
    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.
    stores Sequence[str]
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    path String
    Path to where the back-end is mounted within Vault.
    allowedRoles List<String>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent Boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode String
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl Number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name String
    Name of the transformation to create/update.
    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.
    stores List<String>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing TransformationTokenization Resource

    Get an existing TransformationTokenization 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?: TransformationTokenizationState, opts?: CustomResourceOptions): TransformationTokenization
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allowed_roles: Optional[Sequence[str]] = None,
            convergent: Optional[bool] = None,
            deletion_allowed: Optional[bool] = None,
            mapping_mode: Optional[str] = None,
            max_ttl: Optional[int] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            path: Optional[str] = None,
            stores: Optional[Sequence[str]] = None) -> TransformationTokenization
    func GetTransformationTokenization(ctx *Context, name string, id IDInput, state *TransformationTokenizationState, opts ...ResourceOption) (*TransformationTokenization, error)
    public static TransformationTokenization Get(string name, Input<string> id, TransformationTokenizationState? state, CustomResourceOptions? opts = null)
    public static TransformationTokenization get(String name, Output<String> id, TransformationTokenizationState state, CustomResourceOptions options)
    resources:  _:    type: vault:transform:TransformationTokenization    get:      id: ${id}
    import {
      to = vault_transform_transformation_tokenization.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedRoles List<string>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    Convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    MappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    MaxTtl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    Name string
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    Stores List<string>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    AllowedRoles []string
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    Convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    MappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    MaxTtl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    Name string
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    Stores []string
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    allowed_roles list(string)
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mapping_mode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    max_ttl number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name string
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    stores list(string)
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    allowedRoles List<String>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent Boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode String
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl Integer
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name String
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    stores List<String>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    allowedRoles string[]
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode string
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name string
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    stores string[]
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    allowed_roles Sequence[str]
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent bool
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mapping_mode str
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    max_ttl int
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name str
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    stores Sequence[str]
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    allowedRoles List<String>
    Specifies a list of allowed roles that this transformation can be assigned to. A role using this transformation must exist in this list in order for encode and decode operations to properly function. Default is [].
    convergent Boolean
    Specifies whether to use convergent tokenization, where tokenization of the same plaintext more than once results in the same token. Default is false. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise deletion is blocked while this value remains false. Note that deleting the transform deletes the underlying key, making decoding of tokenized values impossible without restoring from a backup. Default is false.
    mappingMode String
    Specifies the mapping mode for stored tokenization values. Can be "default" or "exportable". "default" is strongly recommended for highest security. "exportable" allows for all plaintexts to be decoded via the export-decoded endpoint in an emergency. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.
    maxTtl Number
    The maximum TTL of a token. If 0 or unspecified, tokens may have no expiration. Default is 0.
    name String
    Name of the transformation to create/update.
    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
    Path to where the back-end is mounted within Vault.
    stores List<String>
    The list of tokenization stores to use for tokenization state. Default is ["builtin/internal"]. Note: This field is immutable and cannot be changed after creation. Changing this value will force recreation of the resource.

    Import

    Transform tokenization transformations can be imported using path/name, e.g.

    $ pulumi import vault:transform/transformationTokenization:TransformationTokenization example transform/transformations/tokenization/tkn-example
    

    Note that the convergent field cannot be recovered from Vault on import and will be empty after import.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Vault pulumi/pulumi-vault
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vault Terraform Provider.
    vault logo vault logo
    Viewing docs for HashiCorp Vault v7.13.0
    published on Friday, Sep 18, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial