KeysPkcArgs

data class KeysPkcArgs(val allowGenerateKey: Output<Boolean>? = null, val allowReplaceKey: Output<Boolean>? = null, val allowStoreKey: Output<Boolean>? = null, val anyMount: Output<Boolean>? = null, val curve: Output<String>? = null, val forceRwSession: Output<String>? = null, val keyBits: Output<String>? = null, val keyId: Output<String>, val keyLabel: Output<String>, val library: Output<String>, val mechanism: Output<String>, val name: Output<String>, val pin: Output<String>, val slot: Output<String>? = null, val tokenLabel: Output<String>? = null, val uuid: Output<String>? = null) : ConvertibleToJava<KeysPkcArgs>

Constructors

Link copied to clipboard
constructor(allowGenerateKey: Output<Boolean>? = null, allowReplaceKey: Output<Boolean>? = null, allowStoreKey: Output<Boolean>? = null, anyMount: Output<Boolean>? = null, curve: Output<String>? = null, forceRwSession: Output<String>? = null, keyBits: Output<String>? = null, keyId: Output<String>, keyLabel: Output<String>, library: Output<String>, mechanism: Output<String>, name: Output<String>, pin: Output<String>, slot: Output<String>? = null, tokenLabel: Output<String>? = null, uuid: Output<String>? = null)

Properties

Link copied to clipboard
val allowGenerateKey: Output<Boolean>? = null

If no existing key can be found in the referenced backend, instructs Vault to generate a key within the backend

Link copied to clipboard
val allowReplaceKey: Output<Boolean>? = null

Controls the ability for Vault to replace through generation or importing a key into the configured backend even if a key is present, if set to false those operations are forbidden if a key exists.

Link copied to clipboard
val allowStoreKey: Output<Boolean>? = null

Controls the ability for Vault to import a key to the configured backend, if 'false', those operations will be forbidden

Link copied to clipboard
val anyMount: Output<Boolean>? = null

Allow usage from any mount point within the namespace if 'true'

Link copied to clipboard
val curve: Output<String>? = null

Supplies the curve value when using the 'CKM_ECDSA' mechanism. Required if 'allow_generate_key' is true

Link copied to clipboard
val forceRwSession: Output<String>? = null

Force all operations to open up a read-write session to the HSM

Link copied to clipboard
val keyBits: Output<String>? = null

Supplies the size in bits of the key when using 'CKM_RSA_PKCS_PSS', 'CKM_RSA_PKCS_OAEP' or 'CKM_RSA_PKCS' as a value for 'mechanism'. Required if 'allow_generate_key' is true

Link copied to clipboard
val keyId: Output<String>

The id of a PKCS#11 key to use

Link copied to clipboard
val keyLabel: Output<String>

The label of the key to use

Link copied to clipboard
val library: Output<String>

The name of the kms_library stanza to use from Vault's config to lookup the local library path

Link copied to clipboard
val mechanism: Output<String>

The encryption/decryption mechanism to use, specified as a hexadecimal (prefixed by 0x) string.

Link copied to clipboard
val name: Output<String>

A unique lowercase name that serves as identifying the key

Link copied to clipboard
val pin: Output<String>

The PIN for login

Link copied to clipboard
val slot: Output<String>? = null

The slot number to use, specified as a string in a decimal format (e.g. '2305843009213693953')

Link copied to clipboard
val tokenLabel: Output<String>? = null

The slot token label to use

Link copied to clipboard
val uuid: Output<String>? = null

ID of the managed key read from Vault

Functions

Link copied to clipboard
open override fun toJava(): KeysPkcArgs