vault.transform.getEncode
Explore with Pulumi AI
This data source supports the “/transform/encode/{role_name}” Vault endpoint.
It encodes the provided value using a named role.
Using getEncode
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 getEncode(args: GetEncodeArgs, opts?: InvokeOptions): Promise<GetEncodeResult>
function getEncodeOutput(args: GetEncodeOutputArgs, opts?: InvokeOptions): Output<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
def get_encode_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,
encoded_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[GetEncodeResult]
func GetEncode(ctx *Context, args *GetEncodeArgs, opts ...InvokeOption) (*GetEncodeResult, error)
func GetEncodeOutput(ctx *Context, args *GetEncodeOutputArgs, opts ...InvokeOption) GetEncodeResultOutput
> Note: This function is named GetEncode
in the Go SDK.
public static class GetEncode
{
public static Task<GetEncodeResult> InvokeAsync(GetEncodeArgs args, InvokeOptions? opts = null)
public static Output<GetEncodeResult> Invoke(GetEncodeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetEncodeResult> getEncode(GetEncodeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: vault:transform/getEncode:getEncode
arguments:
# arguments dictionary
The following arguments are supported:
- Path string
Path to where the back-end is mounted within Vault.
- Role
Name string The name of the role.
- Batch
Inputs 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.
- Batch
Results List<ImmutableDictionary<string, object>> The result of encoding a batch.
- Encoded
Value 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.
- Role
Name string The name of the role.
- Batch
Inputs []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.
- Batch
Results []map[string]interface{} The result of encoding a batch.
- Encoded
Value 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.
- role
Name String The name of the role.
- batch
Inputs List<Map<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.
- batch
Results List<Map<String,Object>> The result of encoding a batch.
- encoded
Value 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.
- role
Name string The name of the role.
- batch
Inputs {[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.
- batch
Results {[key: string]: any}[] The result of encoding a batch.
- encoded
Value 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.
- path String
Path to where the back-end is mounted within Vault.
- role
Name String The name of the role.
- batch
Inputs List<Map<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 List<Map<Any>> The result of encoding a batch.
- encoded
Value 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.
getEncode Result
The following output properties are available:
- Batch
Results List<ImmutableDictionary<string, object>> - Encoded
Value string - Id string
The provider-assigned unique ID for this managed resource.
- Path string
- Role
Name string - Batch
Inputs List<ImmutableDictionary<string, object>> - Transformation string
- Tweak string
- Value string
- Batch
Results []map[string]interface{} - Encoded
Value string - Id string
The provider-assigned unique ID for this managed resource.
- Path string
- Role
Name string - Batch
Inputs []map[string]interface{} - Transformation string
- Tweak string
- Value string
- batch
Results List<Map<String,Object>> - encoded
Value String - id String
The provider-assigned unique ID for this managed resource.
- path String
- role
Name String - batch
Inputs List<Map<String,Object>> - transformation String
- tweak String
- value String
- batch
Results {[key: string]: any}[] - encoded
Value string - id string
The provider-assigned unique ID for this managed resource.
- path string
- role
Name string - batch
Inputs {[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
- batch
Results List<Map<Any>> - encoded
Value String - id String
The provider-assigned unique ID for this managed resource.
- path String
- role
Name String - batch
Inputs 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.