HashiCorp Vault v5.11.0, Apr 25 23

vault.transform.getDecode

Explore with Pulumi AI

This data source supports the “/transform/decode/{role_name}” Vault endpoint.

It decodes the provided value using a named role.

Using getDecode

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDecode(args: GetDecodeArgs, opts?: InvokeOptions): Promise<GetDecodeResult>
function getDecodeOutput(args: GetDecodeOutputArgs, opts?: InvokeOptions): Output<GetDecodeResult>

def get_decode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
               batch_results: Optional[Sequence[Mapping[str, Any]]] = None,
               decoded_value: Optional[str] = None,
               path: Optional[str] = None,
               role_name: Optional[str] = None,
               transformation: Optional[str] = None,
               tweak: Optional[str] = None,
               value: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDecodeResult
def get_decode_output(batch_inputs: Optional[pulumi.Input[Sequence[pulumi.Input[Mapping[str, Any]]]]] = None,
               batch_results: Optional[pulumi.Input[Sequence[pulumi.Input[Mapping[str, Any]]]]] = None,
               decoded_value: Optional[pulumi.Input[str]] = None,
               path: Optional[pulumi.Input[str]] = None,
               role_name: Optional[pulumi.Input[str]] = None,
               transformation: Optional[pulumi.Input[str]] = None,
               tweak: Optional[pulumi.Input[str]] = None,
               value: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDecodeResult]

func GetDecode(ctx *Context, args *GetDecodeArgs, opts ...InvokeOption) (*GetDecodeResult, error)
func GetDecodeOutput(ctx *Context, args *GetDecodeOutputArgs, opts ...InvokeOption) GetDecodeResultOutput

> Note: This function is named GetDecode in the Go SDK.

public static class GetDecode 
{
    public static Task<GetDecodeResult> InvokeAsync(GetDecodeArgs args, InvokeOptions? opts = null)
    public static Output<GetDecodeResult> Invoke(GetDecodeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDecodeResult> getDecode(GetDecodeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: vault:transform/getDecode:getDecode
  arguments:
    # arguments dictionary

The following arguments are supported:

Path string: Path to where the back-end is mounted within Vault.
RoleName string: The name of the role.
BatchInputs List<ImmutableDictionary<string, object>>: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
BatchResults List<ImmutableDictionary<string, object>>: The result of decoding a batch.
DecodedValue string: The result of decoding a value.
Transformation string: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
Tweak string: The tweak value to use. Only applicable for FPE transformations
Value string: The value in which to decode.

Path string: Path to where the back-end is mounted within Vault.
RoleName string: The name of the role.
BatchInputs []map[string]interface{}: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
BatchResults []map[string]interface{}: The result of decoding a batch.
DecodedValue string: The result of decoding a value.
Transformation string: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
Tweak string: The tweak value to use. Only applicable for FPE transformations
Value string: The value in which to decode.

path String: Path to where the back-end is mounted within Vault.
roleName String: The name of the role.
batchInputs List<Map<String,Object>>: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
batchResults List<Map<String,Object>>: The result of decoding a batch.
decodedValue String: The result of decoding a value.
transformation String: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
tweak String: The tweak value to use. Only applicable for FPE transformations
value String: The value in which to decode.

path string: Path to where the back-end is mounted within Vault.
roleName string: The name of the role.
batchInputs {[key: string]: any}[]: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
batchResults {[key: string]: any}[]: The result of decoding a batch.
decodedValue string: The result of decoding a value.
transformation string: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
tweak string: The tweak value to use. Only applicable for FPE transformations
value string: The value in which to decode.

path str: Path to where the back-end is mounted within Vault.
role_name str: The name of the role.
batch_inputs Sequence[Mapping[str, Any]]: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
batch_results Sequence[Mapping[str, Any]]: The result of decoding a batch.
decoded_value str: The result of decoding a value.
transformation str: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
tweak str: The tweak value to use. Only applicable for FPE transformations
value str: The value in which to decode.

path String: Path to where the back-end is mounted within Vault.
roleName String: The name of the role.
batchInputs List<Map<Any>>: Specifies a list of items to be decoded in a single batch. If this parameter is set, the top-level parameters 'value', 'transformation' and 'tweak' will be ignored. Each batch item within the list can specify these parameters instead.
batchResults List<Map<Any>>: The result of decoding a batch.
decodedValue String: The result of decoding a value.
transformation String: The transformation to perform. If no value is provided and the role contains a single transformation, this value will be inferred from the role.
tweak String: The tweak value to use. Only applicable for FPE transformations
value String: The value in which to decode.

getDecode Result

The following output properties are available:

BatchResults List<ImmutableDictionary<string, object>>
DecodedValue string
Id string: The provider-assigned unique ID for this managed resource.
Path string
RoleName string
BatchInputs List<ImmutableDictionary<string, object>>
Transformation string
Tweak string
Value string

BatchResults []map[string]interface{}
DecodedValue string
Id string: The provider-assigned unique ID for this managed resource.
Path string
RoleName string
BatchInputs []map[string]interface{}
Transformation string
Tweak string
Value string

batchResults List<Map<String,Object>>
decodedValue String
id String: The provider-assigned unique ID for this managed resource.
path String
roleName String
batchInputs List<Map<String,Object>>
transformation String
tweak String
value String

batchResults {[key: string]: any}[]
decodedValue string
id string: The provider-assigned unique ID for this managed resource.
path string
roleName string
batchInputs {[key: string]: any}[]
transformation string
tweak string
value string

batch_results Sequence[Mapping[str, Any]]
decoded_value str
id str: The provider-assigned unique ID for this managed resource.
path str
role_name str
batch_inputs Sequence[Mapping[str, Any]]
transformation str
tweak str
value str

batchResults List<Map<Any>>
decodedValue String
id String: The provider-assigned unique ID for this managed resource.
path String
roleName String
batchInputs List<Map<Any>>
transformation String
tweak String
value String

Package Details

Repository: Vault pulumi/pulumi-vault
License: Apache-2.0
Notes: This Pulumi package is based on the vault Terraform Provider.

vault.transform.getDecode

Using getDecode

getDecode Result

Package Details

On this page

On this page