Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. HashiCorp Vault Provider
  4. API Docs
  5. transform
  6. KeyConfiguration
Viewing docs for HashiCorp Vault v7.12.0
published on Saturday, Aug 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vault

vault.transform.KeyConfiguration

vault logo vault logo
Viewing docs for HashiCorp Vault v7.12.0
published on Saturday, Aug 15, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vault

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

    It updates the configuration for a key used in a transform. It only supports tokenization transforms.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";

const mountTransform = new vault.Mount("mount_transform", {
    path: "transform",
    type: "transform",
});
const test = new vault.transform.KeyConfiguration("test", {
    path: mountTransform.path,
    name: "credit-card",
    autoRotatePeriod: 172800,
    minDecryptionVersion: 2,
});

    import pulumi
import pulumi_vault as vault

mount_transform = vault.Mount("mount_transform",
    path="transform",
    type="transform")
test = vault.transform.KeyConfiguration("test",
    path=mount_transform.path,
    name="credit-card",
    auto_rotate_period=172800,
    min_decryption_version=2)

    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 {
		mountTransform, err := vault.NewMount(ctx, "mount_transform", &vault.MountArgs{
			Path: pulumi.String("transform"),
			Type: pulumi.String("transform"),
		})
		if err != nil {
			return err
		}
		_, err = transform.NewKeyConfiguration(ctx, "test", &transform.KeyConfigurationArgs{
			Path:                 mountTransform.Path,
			Name:                 pulumi.String("credit-card"),
			AutoRotatePeriod:     pulumi.Int(172800),
			MinDecryptionVersion: pulumi.Int(2),
		})
		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 mountTransform = new Vault.Mount("mount_transform", new()
    {
        Path = "transform",
        Type = "transform",
    });

    var test = new Vault.Transform.KeyConfiguration("test", new()
    {
        Path = mountTransform.Path,
        Name = "credit-card",
        AutoRotatePeriod = 172800,
        MinDecryptionVersion = 2,
    });

});

    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.KeyConfiguration;
import com.pulumi.vault.transform.KeyConfigurationArgs;
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 mountTransform = new Mount("mountTransform", MountArgs.builder()
            .path("transform")
            .type("transform")
            .build());

        var test = new KeyConfiguration("test", KeyConfigurationArgs.builder()
            .path(mountTransform.path())
            .name("credit-card")
            .autoRotatePeriod(172800)
            .minDecryptionVersion(2)
            .build());

    }
}

    resources:
  mountTransform:
    type: vault:Mount
    name: mount_transform
    properties:
      path: transform
      type: transform
  test:
    type: vault:transform:KeyConfiguration
    properties:
      path: ${mountTransform.path}
      name: credit-card
      autoRotatePeriod: 172800
      minDecryptionVersion: 2

    pulumi {
  required_providers {
    vault = {
      source = "pulumi/vault"
    }
  }
}

resource "vault_mount" "mount_transform" {
  path = "transform"
  type = "transform"
}
resource "vault_transform_keyconfiguration" "test" {
  path                   = vault_mount.mount_transform.path
  name                   = "credit-card"
  auto_rotate_period     = 172800
  min_decryption_version = 2
}

    Create KeyConfiguration Resource

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

    Constructor syntax

    new KeyConfiguration(name: string, args: KeyConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def KeyConfiguration(resource_name: str,
                     args: KeyConfigurationArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def KeyConfiguration(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     path: Optional[str] = None,
                     auto_rotate_period: Optional[int] = None,
                     min_decryption_version: Optional[int] = None,
                     name: Optional[str] = None,
                     namespace: Optional[str] = None)
    func NewKeyConfiguration(ctx *Context, name string, args KeyConfigurationArgs, opts ...ResourceOption) (*KeyConfiguration, error)
    public KeyConfiguration(string name, KeyConfigurationArgs args, CustomResourceOptions? opts = null)
    public KeyConfiguration(String name, KeyConfigurationArgs args)
public KeyConfiguration(String name, KeyConfigurationArgs args, CustomResourceOptions options)

    type: vault:transform:KeyConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "vault_transform_key_configuration" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args KeyConfigurationArgs
    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 KeyConfigurationArgs
    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 KeyConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args KeyConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args KeyConfigurationArgs
    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 keyConfigurationResource = new Vault.Transform.KeyConfiguration("keyConfigurationResource", new()
{
    Path = "string",
    AutoRotatePeriod = 0,
    MinDecryptionVersion = 0,
    Name = "string",
    Namespace = "string",
});

    example, err := transform.NewKeyConfiguration(ctx, "keyConfigurationResource", &transform.KeyConfigurationArgs{
	Path:                 pulumi.String("string"),
	AutoRotatePeriod:     pulumi.Int(0),
	MinDecryptionVersion: pulumi.Int(0),
	Name:                 pulumi.String("string"),
	Namespace:            pulumi.String("string"),
})

    resource "vault_transform_key_configuration" "keyConfigurationResource" {
  lifecycle {
    create_before_destroy = true
  }
  path                   = "string"
  auto_rotate_period     = 0
  min_decryption_version = 0
  name                   = "string"
  namespace              = "string"
}

    var keyConfigurationResource = new KeyConfiguration("keyConfigurationResource", KeyConfigurationArgs.builder()
    .path("string")
    .autoRotatePeriod(0)
    .minDecryptionVersion(0)
    .name("string")
    .namespace("string")
    .build());

    key_configuration_resource = vault.transform.KeyConfiguration("keyConfigurationResource",
    path="string",
    auto_rotate_period=0,
    min_decryption_version=0,
    name="string",
    namespace="string")

    const keyConfigurationResource = new vault.transform.KeyConfiguration("keyConfigurationResource", {
    path: "string",
    autoRotatePeriod: 0,
    minDecryptionVersion: 0,
    name: "string",
    namespace: "string",
});

    type: vault:transform:KeyConfiguration
properties:
    autoRotatePeriod: 0
    minDecryptionVersion: 0
    name: string
    namespace: string
    path: string

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

    Path string
    Path to where the back-end is mounted within Vault.
    AutoRotatePeriod int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    MinDecryptionVersion int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    Name string
    Specifies the transform name to use for this operation.
    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.
    AutoRotatePeriod int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    MinDecryptionVersion int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    Name string
    Specifies the transform name to use for this operation.
    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.
    auto_rotate_period number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    min_decryption_version number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name string
    Specifies the transform name to use for this operation.
    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.
    autoRotatePeriod Integer
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    minDecryptionVersion Integer
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name String
    Specifies the transform name to use for this operation.
    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.
    autoRotatePeriod number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    minDecryptionVersion number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name string
    Specifies the transform name to use for this operation.
    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 str
    Path to where the back-end is mounted within Vault.
    auto_rotate_period int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    min_decryption_version int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name str
    Specifies the transform name to use for this operation.
    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 String
    Path to where the back-end is mounted within Vault.
    autoRotatePeriod Number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    minDecryptionVersion Number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name String
    Specifies the transform name to use for this operation.
    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.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Latest key version available for use.
    MinAvailableVersion int
    Minimum key version available for use.
    Id string
    The provider-assigned unique ID for this managed resource.
    LatestVersion int
    Latest key version available for use.
    MinAvailableVersion int
    Minimum key version available for use.
    id string
    The provider-assigned unique ID for this managed resource.
    latest_version number
    Latest key version available for use.
    min_available_version number
    Minimum key version available for use.
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Integer
    Latest key version available for use.
    minAvailableVersion Integer
    Minimum key version available for use.
    id string
    The provider-assigned unique ID for this managed resource.
    latestVersion number
    Latest key version available for use.
    minAvailableVersion number
    Minimum key version available for use.
    id str
    The provider-assigned unique ID for this managed resource.
    latest_version int
    Latest key version available for use.
    min_available_version int
    Minimum key version available for use.
    id String
    The provider-assigned unique ID for this managed resource.
    latestVersion Number
    Latest key version available for use.
    minAvailableVersion Number
    Minimum key version available for use.

    Look up Existing KeyConfiguration Resource

    Get an existing KeyConfiguration 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?: KeyConfigurationState, opts?: CustomResourceOptions): KeyConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auto_rotate_period: Optional[int] = None,
        latest_version: Optional[int] = None,
        min_available_version: Optional[int] = None,
        min_decryption_version: Optional[int] = None,
        name: Optional[str] = None,
        namespace: Optional[str] = None,
        path: Optional[str] = None) -> KeyConfiguration
    func GetKeyConfiguration(ctx *Context, name string, id IDInput, state *KeyConfigurationState, opts ...ResourceOption) (*KeyConfiguration, error)
    public static KeyConfiguration Get(string name, Input<string> id, KeyConfigurationState? state, CustomResourceOptions? opts = null)
    public static KeyConfiguration get(String name, Output<String> id, KeyConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: vault:transform:KeyConfiguration    get:      id: ${id}
    import {
  to = vault_transform_key_configuration.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:
    AutoRotatePeriod int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    LatestVersion int
    Latest key version available for use.
    MinAvailableVersion int
    Minimum key version available for use.
    MinDecryptionVersion int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    Name string
    Specifies the transform name to use for this operation.
    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.
    AutoRotatePeriod int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    LatestVersion int
    Latest key version available for use.
    MinAvailableVersion int
    Minimum key version available for use.
    MinDecryptionVersion int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    Name string
    Specifies the transform name to use for this operation.
    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.
    auto_rotate_period number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    latest_version number
    Latest key version available for use.
    min_available_version number
    Minimum key version available for use.
    min_decryption_version number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name string
    Specifies the transform name to use for this operation.
    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.
    autoRotatePeriod Integer
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    latestVersion Integer
    Latest key version available for use.
    minAvailableVersion Integer
    Minimum key version available for use.
    minDecryptionVersion Integer
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name String
    Specifies the transform name to use for this operation.
    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.
    autoRotatePeriod number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    latestVersion number
    Latest key version available for use.
    minAvailableVersion number
    Minimum key version available for use.
    minDecryptionVersion number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name string
    Specifies the transform name to use for this operation.
    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.
    auto_rotate_period int
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    latest_version int
    Latest key version available for use.
    min_available_version int
    Minimum key version available for use.
    min_decryption_version int
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name str
    Specifies the transform name to use for this operation.
    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.
    autoRotatePeriod Number
    The amount of time in seconds the key should live before being automatically rotated. Setting this to 0 disables automatic rotation.
    latestVersion Number
    Latest key version available for use.
    minAvailableVersion Number
    Minimum key version available for use.
    minDecryptionVersion Number
    Specifies the minimum key version that vault can use to decode values for the corresponding transform.
    name String
    Specifies the transform name to use for this operation.
    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.

    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.12.0
    published on Saturday, Aug 15, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-vault

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial