pulumi-aws-native-kotlin/com.pulumi.awsnative.kms.kotlin.enums/KeyUsage

KeyUsage

enum KeyUsage : Enum<KeyUsage> , ConvertibleToJava<KeyUsage>

Determines the cryptographic operations for which you can use the KMS key. The default value is `ENCRYPT_DECRYPT`. This property is required for asymmetric KMS keys and HMAC KMS keys. You can't change the `KeyUsage` value after the KMS key is created. If you change the value of the `KeyUsage` property on an existing KMS key, the update request fails, regardless of the value of the UpdateReplacePolicy attribute. This prevents you from accidentally deleting a KMS key by changing an immutable property value. Select only one valid value.

For symmetric encryption KMS keys, omit the parameter or specify `ENCRYPT_DECRYPT`.
For HMAC KMS keys (symmetric), specify `GENERATE_VERIFY_MAC`.
For asymmetric KMS keys with RSA key pairs, specify `ENCRYPT_DECRYPT` or `SIGN_VERIFY`.
For asymmetric KMS keys with NIST-recommended elliptic curve key pairs, specify `SIGN_VERIFY` or `KEY_AGREEMENT`.
For asymmetric KMS keys with `ECC_SECG_P256K1` key pairs specify `SIGN_VERIFY`.
For asymmetric KMS keys with SM2 key pairs (China Regions only), specify `ENCRYPT_DECRYPT`, `SIGN_VERIFY`, or `KEY_AGREEMENT`.

Entries

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<KeyUsage>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

javaValue

val javaValue: KeyUsage

name

val name: String

ordinal

val ordinal: Int

Functions

toJava

open override fun toJava(): KeyUsage

valueOf

fun valueOf(value: String): KeyUsage

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<KeyUsage>

Returns an array containing the constants of this enum type, in the order they're declared.