GetKeyResult

data class GetKeyResult(val arn: String? = null, val description: String? = null, val enableKeyRotation: Boolean? = null, val enabled: Boolean? = null, val keyId: String? = null, val keyPolicy: Any? = null, val keySpec: KeySpec? = null, val keyUsage: KeyUsage? = null, val multiRegion: Boolean? = null, val origin: KeyOrigin? = null, val tags: List<KeyTag>? = null)

Constructors

Link copied to clipboard
fun GetKeyResult(arn: String? = null, description: String? = null, enableKeyRotation: Boolean? = null, enabled: Boolean? = null, keyId: String? = null, keyPolicy: Any? = null, keySpec: KeySpec? = null, keyUsage: KeyUsage? = null, multiRegion: Boolean? = null, origin: KeyOrigin? = null, tags: List<KeyTag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null
Link copied to clipboard
val description: String? = null

A description of the AWS KMS key. Use a description that helps you to distinguish this AWS KMS key from others in the account, such as its intended use.

Link copied to clipboard
val enabled: Boolean? = null

Specifies whether the AWS KMS key is enabled. Disabled AWS KMS keys cannot be used in cryptographic operations.

Link copied to clipboard

Enables automatic rotation of the key material for the specified AWS KMS key. By default, automation key rotation is not enabled.

Link copied to clipboard
val keyId: String? = null
Link copied to clipboard
val keyPolicy: Any? = null

The key policy that authorizes use of the AWS KMS key. The key policy must observe the following rules.

Link copied to clipboard
val keySpec: KeySpec? = null

Specifies the type of AWS KMS key to create. The default value is SYMMETRIC_DEFAULT. This property is required only for asymmetric AWS KMS keys. You can't change the KeySpec value after the AWS KMS key is created.

Link copied to clipboard
val keyUsage: KeyUsage? = null

Determines the cryptographic operations for which you can use the AWS KMS key. The default value is ENCRYPT_DECRYPT. This property is required only for asymmetric AWS KMS keys. You can't change the KeyUsage value after the AWS KMS key is created.

Link copied to clipboard
val multiRegion: Boolean? = null

Specifies whether the AWS KMS key should be Multi-Region. You can't change the MultiRegion value after the AWS KMS key is created.

Link copied to clipboard
val origin: KeyOrigin? = null

The source of the key material for the KMS key. You cannot change the origin after you create the KMS key. The default is AWS_KMS, which means that AWS KMS creates the key material.

Link copied to clipboard
val tags: List<KeyTag>? = null

An array of key-value pairs to apply to this resource.