getEncode

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

It encodes the provided value using a named role.

Using getEncode

function getEncode(args: GetEncodeArgs, opts?: InvokeOptions): Promise<GetEncodeResult>
def get_encode(batch_inputs: Optional[Sequence[Mapping[str, Any]]] = None,
               batch_results: Optional[Sequence[Mapping[str, Any]]] = None,
               encoded_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) -> GetEncodeResult
func GetEncode(ctx *Context, args *GetEncodeArgs, opts ...InvokeOption) (*GetEncodeResult, error)

Note: This function is named GetEncode in the Go SDK.

public static class GetEncode {
    public static Task<GetEncodeResult> InvokeAsync(GetEncodeArgs args, InvokeOptions? opts = null)
}

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 encoded in a single batch. If this parameter is set, the 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 encoding a batch.
EncodedValue string
The result of encoding 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 encode.
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 encoded in a single batch. If this parameter is set, the 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 encoding a batch.
EncodedValue string
The result of encoding 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 encode.
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 encoded in a single batch. If this parameter is set, the 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 encoding a batch.
encodedValue string
The result of encoding 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 encode.
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 encoded in a single batch. If this parameter is set, the 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 encoding a batch.
encoded_value str
The result of encoding 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 encode.

getEncode Result

The following output properties are available:

BatchResults List<ImmutableDictionary<string, object>>
EncodedValue 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{}
EncodedValue 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 {[key: string]: any}[]
encodedValue 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]]
encoded_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

Package Details

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