getEncrypt

This is a data source which can be used to encrypt plaintext using a Vault Transit key.

Using getEncrypt

function getEncrypt(args: GetEncryptArgs, opts?: InvokeOptions): Promise<GetEncryptResult>
def get_encrypt(backend: Optional[str] = None,
                context: Optional[str] = None,
                key: Optional[str] = None,
                key_version: Optional[int] = None,
                plaintext: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetEncryptResult
func GetEncrypt(ctx *Context, args *GetEncryptArgs, opts ...InvokeOption) (*GetEncryptResult, error)

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

public static class GetEncrypt {
    public static Task<GetEncryptResult> InvokeAsync(GetEncryptArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Backend string
The path the transit secret backend is mounted at, with no leading or trailing /.
Key string
Specifies the name of the transit key to encrypt against.
Plaintext string
Plaintext to be encoded.
Context string
Context for key derivation. This is required if key derivation is enabled for this key.
KeyVersion int
The version of the key to use for encryption. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.
Backend string
The path the transit secret backend is mounted at, with no leading or trailing /.
Key string
Specifies the name of the transit key to encrypt against.
Plaintext string
Plaintext to be encoded.
Context string
Context for key derivation. This is required if key derivation is enabled for this key.
KeyVersion int
The version of the key to use for encryption. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.
backend string
The path the transit secret backend is mounted at, with no leading or trailing /.
key string
Specifies the name of the transit key to encrypt against.
plaintext string
Plaintext to be encoded.
context string
Context for key derivation. This is required if key derivation is enabled for this key.
keyVersion number
The version of the key to use for encryption. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.
backend str
The path the transit secret backend is mounted at, with no leading or trailing /.
key str
Specifies the name of the transit key to encrypt against.
plaintext str
Plaintext to be encoded.
context str
Context for key derivation. This is required if key derivation is enabled for this key.
key_version int
The version of the key to use for encryption. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.

getEncrypt Result

The following output properties are available:

Backend string
Ciphertext string
Encrypted ciphertext returned from Vault
Id string
The provider-assigned unique ID for this managed resource.
Key string
Plaintext string
Context string
KeyVersion int
Backend string
Ciphertext string
Encrypted ciphertext returned from Vault
Id string
The provider-assigned unique ID for this managed resource.
Key string
Plaintext string
Context string
KeyVersion int
backend string
ciphertext string
Encrypted ciphertext returned from Vault
id string
The provider-assigned unique ID for this managed resource.
key string
plaintext string
context string
keyVersion number
backend str
ciphertext str
Encrypted ciphertext returned from Vault
id str
The provider-assigned unique ID for this managed resource.
key str
plaintext str
context str
key_version int

Package Details

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