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

vault.transform.Transformation

Explore with Pulumi AI

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

    Create Transformation Resource

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

    Constructor syntax

    new Transformation(name: string, args: TransformationArgs, opts?: CustomResourceOptions);
    @overload
    def Transformation(resource_name: str,
                       args: TransformationArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def Transformation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       path: Optional[str] = None,
                       allowed_roles: Optional[Sequence[str]] = None,
                       deletion_allowed: Optional[bool] = None,
                       masking_character: Optional[str] = None,
                       name: Optional[str] = None,
                       namespace: Optional[str] = None,
                       template: Optional[str] = None,
                       templates: Optional[Sequence[str]] = None,
                       tweak_source: Optional[str] = None,
                       type: Optional[str] = None)
    func NewTransformation(ctx *Context, name string, args TransformationArgs, opts ...ResourceOption) (*Transformation, error)
    public Transformation(string name, TransformationArgs args, CustomResourceOptions? opts = null)
    public Transformation(String name, TransformationArgs args)
    public Transformation(String name, TransformationArgs args, CustomResourceOptions options)
    
    type: vault:transform:Transformation
    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 TransformationArgs
    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 TransformationArgs
    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 TransformationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransformationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransformationArgs
    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 transformationResource = new Vault.Transform.Transformation("transformationResource", new()
    {
        Path = "string",
        AllowedRoles = new[]
        {
            "string",
        },
        DeletionAllowed = false,
        MaskingCharacter = "string",
        Name = "string",
        Namespace = "string",
        Template = "string",
        Templates = new[]
        {
            "string",
        },
        TweakSource = "string",
        Type = "string",
    });
    
    example, err := transform.NewTransformation(ctx, "transformationResource", &transform.TransformationArgs{
    	Path: pulumi.String("string"),
    	AllowedRoles: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DeletionAllowed:  pulumi.Bool(false),
    	MaskingCharacter: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	Namespace:        pulumi.String("string"),
    	Template:         pulumi.String("string"),
    	Templates: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	TweakSource: pulumi.String("string"),
    	Type:        pulumi.String("string"),
    })
    
    var transformationResource = new Transformation("transformationResource", TransformationArgs.builder()
        .path("string")
        .allowedRoles("string")
        .deletionAllowed(false)
        .maskingCharacter("string")
        .name("string")
        .namespace("string")
        .template("string")
        .templates("string")
        .tweakSource("string")
        .type("string")
        .build());
    
    transformation_resource = vault.transform.Transformation("transformationResource",
        path="string",
        allowed_roles=["string"],
        deletion_allowed=False,
        masking_character="string",
        name="string",
        namespace="string",
        template="string",
        templates=["string"],
        tweak_source="string",
        type="string")
    
    const transformationResource = new vault.transform.Transformation("transformationResource", {
        path: "string",
        allowedRoles: ["string"],
        deletionAllowed: false,
        maskingCharacter: "string",
        name: "string",
        namespace: "string",
        template: "string",
        templates: ["string"],
        tweakSource: "string",
        type: "string",
    });
    
    type: vault:transform:Transformation
    properties:
        allowedRoles:
            - string
        deletionAllowed: false
        maskingCharacter: string
        name: string
        namespace: string
        path: string
        template: string
        templates:
            - string
        tweakSource: string
        type: string
    

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

    Path string
    Path to where the back-end is mounted within Vault.
    AllowedRoles List<string>
    The set of roles allowed to perform this transformation.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    MaskingCharacter string
    The character used to replace data when in masking mode
    Name string
    The name of the transformation.
    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.
    Template string
    The name of the template to use.
    Templates List<string>
    Templates configured for transformation.
    TweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    Type string
    The type of transformation to perform.
    Path string
    Path to where the back-end is mounted within Vault.
    AllowedRoles []string
    The set of roles allowed to perform this transformation.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    MaskingCharacter string
    The character used to replace data when in masking mode
    Name string
    The name of the transformation.
    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.
    Template string
    The name of the template to use.
    Templates []string
    Templates configured for transformation.
    TweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    Type string
    The type of transformation to perform.
    path String
    Path to where the back-end is mounted within Vault.
    allowedRoles List<String>
    The set of roles allowed to perform this transformation.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter String
    The character used to replace data when in masking mode
    name String
    The name of the transformation.
    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.
    template String
    The name of the template to use.
    templates List<String>
    Templates configured for transformation.
    tweakSource String
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type String
    The type of transformation to perform.
    path string
    Path to where the back-end is mounted within Vault.
    allowedRoles string[]
    The set of roles allowed to perform this transformation.
    deletionAllowed boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter string
    The character used to replace data when in masking mode
    name string
    The name of the transformation.
    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.
    template string
    The name of the template to use.
    templates string[]
    Templates configured for transformation.
    tweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type string
    The type of transformation to perform.
    path str
    Path to where the back-end is mounted within Vault.
    allowed_roles Sequence[str]
    The set of roles allowed to perform this transformation.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    masking_character str
    The character used to replace data when in masking mode
    name str
    The name of the transformation.
    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.
    template str
    The name of the template to use.
    templates Sequence[str]
    Templates configured for transformation.
    tweak_source str
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type str
    The type of transformation to perform.
    path String
    Path to where the back-end is mounted within Vault.
    allowedRoles List<String>
    The set of roles allowed to perform this transformation.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter String
    The character used to replace data when in masking mode
    name String
    The name of the transformation.
    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.
    template String
    The name of the template to use.
    templates List<String>
    Templates configured for transformation.
    tweakSource String
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type String
    The type of transformation to perform.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Transformation 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 Transformation Resource

    Get an existing Transformation 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?: TransformationState, opts?: CustomResourceOptions): Transformation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allowed_roles: Optional[Sequence[str]] = None,
            deletion_allowed: Optional[bool] = None,
            masking_character: Optional[str] = None,
            name: Optional[str] = None,
            namespace: Optional[str] = None,
            path: Optional[str] = None,
            template: Optional[str] = None,
            templates: Optional[Sequence[str]] = None,
            tweak_source: Optional[str] = None,
            type: Optional[str] = None) -> Transformation
    func GetTransformation(ctx *Context, name string, id IDInput, state *TransformationState, opts ...ResourceOption) (*Transformation, error)
    public static Transformation Get(string name, Input<string> id, TransformationState? state, CustomResourceOptions? opts = null)
    public static Transformation get(String name, Output<String> id, TransformationState 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:
    AllowedRoles List<string>
    The set of roles allowed to perform this transformation.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    MaskingCharacter string
    The character used to replace data when in masking mode
    Name string
    The name of the transformation.
    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.
    Template string
    The name of the template to use.
    Templates List<string>
    Templates configured for transformation.
    TweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    Type string
    The type of transformation to perform.
    AllowedRoles []string
    The set of roles allowed to perform this transformation.
    DeletionAllowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    MaskingCharacter string
    The character used to replace data when in masking mode
    Name string
    The name of the transformation.
    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.
    Template string
    The name of the template to use.
    Templates []string
    Templates configured for transformation.
    TweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    Type string
    The type of transformation to perform.
    allowedRoles List<String>
    The set of roles allowed to perform this transformation.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter String
    The character used to replace data when in masking mode
    name String
    The name of the transformation.
    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.
    template String
    The name of the template to use.
    templates List<String>
    Templates configured for transformation.
    tweakSource String
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type String
    The type of transformation to perform.
    allowedRoles string[]
    The set of roles allowed to perform this transformation.
    deletionAllowed boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter string
    The character used to replace data when in masking mode
    name string
    The name of the transformation.
    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.
    template string
    The name of the template to use.
    templates string[]
    Templates configured for transformation.
    tweakSource string
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type string
    The type of transformation to perform.
    allowed_roles Sequence[str]
    The set of roles allowed to perform this transformation.
    deletion_allowed bool
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    masking_character str
    The character used to replace data when in masking mode
    name str
    The name of the transformation.
    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.
    template str
    The name of the template to use.
    templates Sequence[str]
    Templates configured for transformation.
    tweak_source str
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type str
    The type of transformation to perform.
    allowedRoles List<String>
    The set of roles allowed to perform this transformation.
    deletionAllowed Boolean
    If true, this transform can be deleted. Otherwise, deletion is blocked while this value remains false. Default: false Only supported on vault-1.12+
    maskingCharacter String
    The character used to replace data when in masking mode
    name String
    The name of the transformation.
    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.
    template String
    The name of the template to use.
    templates List<String>
    Templates configured for transformation.
    tweakSource String
    The source of where the tweak value comes from. Only valid when in FPE mode.
    type String
    The type of transformation to perform.

    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