1. Packages
  2. HashiCorp Vault
  3. API Docs
  4. transform
  5. Alphabet
HashiCorp Vault v6.1.1 published on Wednesday, Jun 5, 2024 by Pulumi

vault.transform.Alphabet

Explore with Pulumi AI

vault logo
HashiCorp Vault v6.1.1 published on Wednesday, Jun 5, 2024 by Pulumi

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

    It queries an existing alphabet by the given name.

    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.Alphabet("test", {
        path: mountTransform.path,
        name: "numerics",
        alphabet: "0123456789",
    });
    
    import pulumi
    import pulumi_vault as vault
    
    mount_transform = vault.Mount("mount_transform",
        path="transform",
        type="transform")
    test = vault.transform.Alphabet("test",
        path=mount_transform.path,
        name="numerics",
        alphabet="0123456789")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault"
    	"github.com/pulumi/pulumi-vault/sdk/v6/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.NewAlphabet(ctx, "test", &transform.AlphabetArgs{
    			Path:     mountTransform.Path,
    			Name:     pulumi.String("numerics"),
    			Alphabet: pulumi.String("0123456789"),
    		})
    		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.Alphabet("test", new()
        {
            Path = mountTransform.Path,
            Name = "numerics",
            AlphabetSet = "0123456789",
        });
    
    });
    
    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.Alphabet;
    import com.pulumi.vault.transform.AlphabetArgs;
    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 mountTransform = new Mount("mountTransform", MountArgs.builder()
                .path("transform")
                .type("transform")
                .build());
    
            var test = new Alphabet("test", AlphabetArgs.builder()
                .path(mountTransform.path())
                .name("numerics")
                .alphabet("0123456789")
                .build());
    
        }
    }
    
    resources:
      mountTransform:
        type: vault:Mount
        name: mount_transform
        properties:
          path: transform
          type: transform
      test:
        type: vault:transform:Alphabet
        properties:
          path: ${mountTransform.path}
          name: numerics
          alphabet: '0123456789'
    

    Create Alphabet Resource

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

    Constructor syntax

    new Alphabet(name: string, args: AlphabetArgs, opts?: CustomResourceOptions);
    @overload
    def Alphabet(resource_name: str,
                 args: AlphabetArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def Alphabet(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 path: Optional[str] = None,
                 alphabet: Optional[str] = None,
                 name: Optional[str] = None,
                 namespace: Optional[str] = None)
    func NewAlphabet(ctx *Context, name string, args AlphabetArgs, opts ...ResourceOption) (*Alphabet, error)
    public Alphabet(string name, AlphabetArgs args, CustomResourceOptions? opts = null)
    public Alphabet(String name, AlphabetArgs args)
    public Alphabet(String name, AlphabetArgs args, CustomResourceOptions options)
    
    type: vault:transform:Alphabet
    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 AlphabetArgs
    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 AlphabetArgs
    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 AlphabetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlphabetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlphabetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var alphabetResource = new Vault.Transform.Alphabet("alphabetResource", new()
    {
        Path = "string",
        AlphabetSet = "string",
        Name = "string",
        Namespace = "string",
    });
    
    example, err := transform.NewAlphabet(ctx, "alphabetResource", &transform.AlphabetArgs{
    	Path:      pulumi.String("string"),
    	Alphabet:  pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Namespace: pulumi.String("string"),
    })
    
    var alphabetResource = new Alphabet("alphabetResource", AlphabetArgs.builder()
        .path("string")
        .alphabet("string")
        .name("string")
        .namespace("string")
        .build());
    
    alphabet_resource = vault.transform.Alphabet("alphabetResource",
        path="string",
        alphabet="string",
        name="string",
        namespace="string")
    
    const alphabetResource = new vault.transform.Alphabet("alphabetResource", {
        path: "string",
        alphabet: "string",
        name: "string",
        namespace: "string",
    });
    
    type: vault:transform:Alphabet
    properties:
        alphabet: string
        name: string
        namespace: string
        path: string
    

    Alphabet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Alphabet resource accepts the following input properties:

    Path string
    Path to where the back-end is mounted within Vault.
    AlphabetSet string
    A string of characters that contains the alphabet set.
    Name string
    The name of the alphabet.
    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.
    Alphabet string
    A string of characters that contains the alphabet set.
    Name string
    The name of the alphabet.
    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.
    alphabet String
    A string of characters that contains the alphabet set.
    name String
    The name of the alphabet.
    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.
    alphabet string
    A string of characters that contains the alphabet set.
    name string
    The name of the alphabet.
    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.
    alphabet str
    A string of characters that contains the alphabet set.
    name str
    The name of the alphabet.
    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.
    alphabet String
    A string of characters that contains the alphabet set.
    name String
    The name of the alphabet.
    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 Alphabet 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Alphabet Resource

    Get an existing Alphabet 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?: AlphabetState, opts?: CustomResourceOptions): Alphabet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alphabet: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            path: Optional[str] = None) -> Alphabet
    func GetAlphabet(ctx *Context, name string, id IDInput, state *AlphabetState, opts ...ResourceOption) (*Alphabet, error)
    public static Alphabet Get(string name, Input<string> id, AlphabetState? state, CustomResourceOptions? opts = null)
    public static Alphabet get(String name, Output<String> id, AlphabetState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AlphabetSet string
    A string of characters that contains the alphabet set.
    Name string
    The name of the alphabet.
    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.
    Alphabet string
    A string of characters that contains the alphabet set.
    Name string
    The name of the alphabet.
    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.
    alphabet String
    A string of characters that contains the alphabet set.
    name String
    The name of the alphabet.
    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.
    alphabet string
    A string of characters that contains the alphabet set.
    name string
    The name of the alphabet.
    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.
    alphabet str
    A string of characters that contains the alphabet set.
    name str
    The name of the alphabet.
    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.
    alphabet String
    A string of characters that contains the alphabet set.
    name String
    The name of the alphabet.
    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
    HashiCorp Vault v6.1.1 published on Wednesday, Jun 5, 2024 by Pulumi