Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. Tokenizer
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.Tokenizer

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    Tokenizer resource

    Create Tokenizer Resource

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

    Constructor syntax

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

@overload
def Tokenizer(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              template_type: Optional[str] = None,
              description: Optional[str] = None,
              delete_protection: Optional[str] = None,
              alphabet: Optional[str] = None,
              encoding_template: Optional[str] = None,
              encryption_key_name: Optional[str] = None,
              name: Optional[str] = None,
              pattern: Optional[str] = None,
              tags: Optional[Sequence[str]] = None,
              decoding_template: Optional[str] = None,
              tokenizer_id: Optional[str] = None,
              tokenizer_type: Optional[str] = None,
              tweak_type: Optional[str] = None)
    func NewTokenizer(ctx *Context, name string, args TokenizerArgs, opts ...ResourceOption) (*Tokenizer, error)
    public Tokenizer(string name, TokenizerArgs args, CustomResourceOptions? opts = null)
    public Tokenizer(String name, TokenizerArgs args)
public Tokenizer(String name, TokenizerArgs args, CustomResourceOptions options)

    type: akeyless:Tokenizer
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 TokenizerArgs
    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 TokenizerArgs
    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 TokenizerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TokenizerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TokenizerArgs
    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 tokenizerResource = new Akeyless.Tokenizer("tokenizerResource", new()
{
    TemplateType = "string",
    Description = "string",
    DeleteProtection = "string",
    Alphabet = "string",
    EncodingTemplate = "string",
    EncryptionKeyName = "string",
    Name = "string",
    Pattern = "string",
    Tags = new[]
    {
        "string",
    },
    DecodingTemplate = "string",
    TokenizerId = "string",
    TokenizerType = "string",
    TweakType = "string",
});

    example, err := akeyless.NewTokenizer(ctx, "tokenizerResource", &akeyless.TokenizerArgs{
	TemplateType:      pulumi.String("string"),
	Description:       pulumi.String("string"),
	DeleteProtection:  pulumi.String("string"),
	Alphabet:          pulumi.String("string"),
	EncodingTemplate:  pulumi.String("string"),
	EncryptionKeyName: pulumi.String("string"),
	Name:              pulumi.String("string"),
	Pattern:           pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	DecodingTemplate: pulumi.String("string"),
	TokenizerId:      pulumi.String("string"),
	TokenizerType:    pulumi.String("string"),
	TweakType:        pulumi.String("string"),
})

    var tokenizerResource = new Tokenizer("tokenizerResource", TokenizerArgs.builder()
    .templateType("string")
    .description("string")
    .deleteProtection("string")
    .alphabet("string")
    .encodingTemplate("string")
    .encryptionKeyName("string")
    .name("string")
    .pattern("string")
    .tags("string")
    .decodingTemplate("string")
    .tokenizerId("string")
    .tokenizerType("string")
    .tweakType("string")
    .build());

    tokenizer_resource = akeyless.Tokenizer("tokenizerResource",
    template_type="string",
    description="string",
    delete_protection="string",
    alphabet="string",
    encoding_template="string",
    encryption_key_name="string",
    name="string",
    pattern="string",
    tags=["string"],
    decoding_template="string",
    tokenizer_id="string",
    tokenizer_type="string",
    tweak_type="string")

    const tokenizerResource = new akeyless.Tokenizer("tokenizerResource", {
    templateType: "string",
    description: "string",
    deleteProtection: "string",
    alphabet: "string",
    encodingTemplate: "string",
    encryptionKeyName: "string",
    name: "string",
    pattern: "string",
    tags: ["string"],
    decodingTemplate: "string",
    tokenizerId: "string",
    tokenizerType: "string",
    tweakType: "string",
});

    type: akeyless:Tokenizer
properties:
    alphabet: string
    decodingTemplate: string
    deleteProtection: string
    description: string
    encodingTemplate: string
    encryptionKeyName: string
    name: string
    pattern: string
    tags:
        - string
    templateType: string
    tokenizerId: string
    tokenizerType: string
    tweakType: string

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

    TemplateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    Alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    DecodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    DeleteProtection string
    Protection from accidental deletion of this item, [true/false]
    Description string
    Description of the object
    EncodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    EncryptionKeyName string
    AES key name to use in vaultless tokenization
    Name string
    Tokenizer name
    Pattern string
    Pattern to use in custom vaultless tokenization
    Tags List<string>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    TokenizerId string
    The ID of this resource.
    TokenizerType string
    Tokenizer type(vaultless)
    TweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    TemplateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    Alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    DecodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    DeleteProtection string
    Protection from accidental deletion of this item, [true/false]
    Description string
    Description of the object
    EncodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    EncryptionKeyName string
    AES key name to use in vaultless tokenization
    Name string
    Tokenizer name
    Pattern string
    Pattern to use in custom vaultless tokenization
    Tags []string
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    TokenizerId string
    The ID of this resource.
    TokenizerType string
    Tokenizer type(vaultless)
    TweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    templateType String
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    alphabet String
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate String
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection String
    Protection from accidental deletion of this item, [true/false]
    description String
    Description of the object
    encodingTemplate String
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName String
    AES key name to use in vaultless tokenization
    name String
    Tokenizer name
    pattern String
    Pattern to use in custom vaultless tokenization
    tags List<String>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    tokenizerId String
    The ID of this resource.
    tokenizerType String
    Tokenizer type(vaultless)
    tweakType String
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    templateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection string
    Protection from accidental deletion of this item, [true/false]
    description string
    Description of the object
    encodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName string
    AES key name to use in vaultless tokenization
    name string
    Tokenizer name
    pattern string
    Pattern to use in custom vaultless tokenization
    tags string[]
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    tokenizerId string
    The ID of this resource.
    tokenizerType string
    Tokenizer type(vaultless)
    tweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    template_type str
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    alphabet str
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decoding_template str
    The Decoding output template to use in custom vaultless tokenization
    delete_protection str
    Protection from accidental deletion of this item, [true/false]
    description str
    Description of the object
    encoding_template str
    The Encoding output template to use in custom vaultless tokenization
    encryption_key_name str
    AES key name to use in vaultless tokenization
    name str
    Tokenizer name
    pattern str
    Pattern to use in custom vaultless tokenization
    tags Sequence[str]
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    tokenizer_id str
    The ID of this resource.
    tokenizer_type str
    Tokenizer type(vaultless)
    tweak_type str
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    templateType String
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    alphabet String
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate String
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection String
    Protection from accidental deletion of this item, [true/false]
    description String
    Description of the object
    encodingTemplate String
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName String
    AES key name to use in vaultless tokenization
    name String
    Tokenizer name
    pattern String
    Pattern to use in custom vaultless tokenization
    tags List<String>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    tokenizerId String
    The ID of this resource.
    tokenizerType String
    Tokenizer type(vaultless)
    tweakType String
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]

    Outputs

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

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

    Look up Existing Tokenizer Resource

    Get an existing Tokenizer 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?: TokenizerState, opts?: CustomResourceOptions): Tokenizer
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        alphabet: Optional[str] = None,
        decoding_template: Optional[str] = None,
        delete_protection: Optional[str] = None,
        description: Optional[str] = None,
        encoding_template: Optional[str] = None,
        encryption_key_name: Optional[str] = None,
        name: Optional[str] = None,
        pattern: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        template_type: Optional[str] = None,
        tokenizer_id: Optional[str] = None,
        tokenizer_type: Optional[str] = None,
        tweak: Optional[str] = None,
        tweak_type: Optional[str] = None) -> Tokenizer
    func GetTokenizer(ctx *Context, name string, id IDInput, state *TokenizerState, opts ...ResourceOption) (*Tokenizer, error)
    public static Tokenizer Get(string name, Input<string> id, TokenizerState? state, CustomResourceOptions? opts = null)
    public static Tokenizer get(String name, Output<String> id, TokenizerState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:Tokenizer    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:
    Alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    DecodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    DeleteProtection string
    Protection from accidental deletion of this item, [true/false]
    Description string
    Description of the object
    EncodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    EncryptionKeyName string
    AES key name to use in vaultless tokenization
    Name string
    Tokenizer name
    Pattern string
    Pattern to use in custom vaultless tokenization
    Tags List<string>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    TemplateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    TokenizerId string
    The ID of this resource.
    TokenizerType string
    Tokenizer type(vaultless)
    Tweak string
    TweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    Alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    DecodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    DeleteProtection string
    Protection from accidental deletion of this item, [true/false]
    Description string
    Description of the object
    EncodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    EncryptionKeyName string
    AES key name to use in vaultless tokenization
    Name string
    Tokenizer name
    Pattern string
    Pattern to use in custom vaultless tokenization
    Tags []string
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    TemplateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    TokenizerId string
    The ID of this resource.
    TokenizerType string
    Tokenizer type(vaultless)
    Tweak string
    TweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    alphabet String
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate String
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection String
    Protection from accidental deletion of this item, [true/false]
    description String
    Description of the object
    encodingTemplate String
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName String
    AES key name to use in vaultless tokenization
    name String
    Tokenizer name
    pattern String
    Pattern to use in custom vaultless tokenization
    tags List<String>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    templateType String
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    tokenizerId String
    The ID of this resource.
    tokenizerType String
    Tokenizer type(vaultless)
    tweak String
    tweakType String
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    alphabet string
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate string
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection string
    Protection from accidental deletion of this item, [true/false]
    description string
    Description of the object
    encodingTemplate string
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName string
    AES key name to use in vaultless tokenization
    name string
    Tokenizer name
    pattern string
    Pattern to use in custom vaultless tokenization
    tags string[]
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    templateType string
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    tokenizerId string
    The ID of this resource.
    tokenizerType string
    Tokenizer type(vaultless)
    tweak string
    tweakType string
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    alphabet str
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decoding_template str
    The Decoding output template to use in custom vaultless tokenization
    delete_protection str
    Protection from accidental deletion of this item, [true/false]
    description str
    Description of the object
    encoding_template str
    The Encoding output template to use in custom vaultless tokenization
    encryption_key_name str
    AES key name to use in vaultless tokenization
    name str
    Tokenizer name
    pattern str
    Pattern to use in custom vaultless tokenization
    tags Sequence[str]
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    template_type str
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    tokenizer_id str
    The ID of this resource.
    tokenizer_type str
    Tokenizer type(vaultless)
    tweak str
    tweak_type str
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]
    alphabet String
    Alphabet to use in custom vaultless tokenization, such as '0123456789' for credit cards.
    decodingTemplate String
    The Decoding output template to use in custom vaultless tokenization
    deleteProtection String
    Protection from accidental deletion of this item, [true/false]
    description String
    Description of the object
    encodingTemplate String
    The Encoding output template to use in custom vaultless tokenization
    encryptionKeyName String
    AES key name to use in vaultless tokenization
    name String
    Tokenizer name
    pattern String
    Pattern to use in custom vaultless tokenization
    tags List<String>
    List of the tags attached to this key. To specify multiple tags use argument multiple times: --tag Tag1 --tag Tag2
    templateType String
    Which template type this tokenizer is used for [SSN,CreditCard,USPhoneNumber,Custom]
    tokenizerId String
    The ID of this resource.
    tokenizerType String
    Tokenizer type(vaultless)
    tweak String
    tweakType String
    The tweak type to use in vaultless tokenization [Supplied, Generated, Internal, Masking]

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless