GetKeyResult

data class GetKeyResult(val arn: String, val awsAccountId: String, val cloudHsmClusterId: String, val creationDate: String, val customKeyStoreId: String, val customerMasterKeySpec: String, val deletionDate: String, val description: String, val enabled: Boolean, val expirationModel: String, val grantTokens: List<String>? = null, val id: String, val keyId: String, val keyManager: String, val keySpec: String, val keyState: String, val keyUsage: String, val multiRegion: Boolean, val multiRegionConfigurations: List<GetKeyMultiRegionConfiguration>, val origin: String, val pendingDeletionWindowInDays: Int, val validTo: String, val xksKeyConfigurations: List<GetKeyXksKeyConfiguration>)

A collection of values returned by getKey.

Constructors

Link copied to clipboard
constructor(arn: String, awsAccountId: String, cloudHsmClusterId: String, creationDate: String, customKeyStoreId: String, customerMasterKeySpec: String, deletionDate: String, description: String, enabled: Boolean, expirationModel: String, grantTokens: List<String>? = null, id: String, keyId: String, keyManager: String, keySpec: String, keyState: String, keyUsage: String, multiRegion: Boolean, multiRegionConfigurations: List<GetKeyMultiRegionConfiguration>, origin: String, pendingDeletionWindowInDays: Int, validTo: String, xksKeyConfigurations: List<GetKeyXksKeyConfiguration>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String

The key ARN of a primary or replica key of a multi-Region key.

Link copied to clipboard

The twelve-digit account ID of the AWS account that owns the key

Link copied to clipboard

The cluster ID of the AWS CloudHSM cluster that contains the key material for the KMS key.

Link copied to clipboard

The date and time when the key was created

Link copied to clipboard

Specifies whether the key contains a symmetric key or an asymmetric key pair and the encryption algorithms or signing algorithms that the key supports

Link copied to clipboard

A unique identifier for the custom key store that contains the KMS key.

Link copied to clipboard

The date and time after which AWS KMS deletes the key. This value is present only when key_state is PendingDeletion, otherwise this value is 0

Link copied to clipboard

The description of the key.

Link copied to clipboard

Specifies whether the key is enabled. When key_state is Enabled this value is true, otherwise it is false

Link copied to clipboard

Specifies whether the Key's key material expires. This value is present only when origin is EXTERNAL, otherwise this value is empty

Link copied to clipboard
val grantTokens: List<String>? = null
Link copied to clipboard
val id: String

The provider-assigned unique ID for this managed resource.

Link copied to clipboard
Link copied to clipboard

The key's manager

Link copied to clipboard

Describes the type of key material in the KMS key.

Link copied to clipboard

The state of the key

Link copied to clipboard

Specifies the intended use of the key

Link copied to clipboard

Indicates whether the KMS key is a multi-Region (true) or regional (false) key.

Link copied to clipboard

Lists the primary and replica keys in same multi-Region key. Present only when the value of multi_region is true.

Link copied to clipboard

When this value is AWS_KMS, AWS KMS created the key material. When this value is EXTERNAL, the key material was imported from your existing key management infrastructure or the CMK lacks key material

Link copied to clipboard

The waiting period before the primary key in a multi-Region key is deleted.

Link copied to clipboard

The time at which the imported key material expires. This value is present only when origin is EXTERNAL and whose expiration_model is KEY_MATERIAL_EXPIRES, otherwise this value is 0

Link copied to clipboard

Information about the external key that is associated with a KMS key in an external key store.