GoogleApi.CloudKMS.V1.Model.CryptoKey (google_api_cloud_kms v0.34.0) View Source
A CryptoKey represents a logical key that can be used for cryptographic operations. A CryptoKey is made up of zero or more versions, which represent the actual key material used in cryptographic operations.
Attributes
-
createTime
(type:DateTime.t
, default:nil
) - Output only. The time at which this CryptoKey was created. -
destroyScheduledDuration
(type:String.t
, default:nil
) - Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. -
importOnly
(type:boolean()
, default:nil
) - Immutable. Whether this key may contain imported versions only. -
labels
(type:map()
, default:nil
) - Labels with user-defined metadata. For more information, see Labeling Keys. -
name
(type:String.t
, default:nil
) - Output only. The resource name for this CryptoKey in the formatprojects/*/locations/*/keyRings/*/cryptoKeys/*
. -
nextRotationTime
(type:DateTime.t
, default:nil
) - At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. -
primary
(type:GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t
, default:nil
) - Output only. A copy of the "primary" CryptoKeyVersion that will be used by Encrypt when this CryptoKey is given in EncryptRequest.name. The CryptoKey's primary version can be updated via UpdateCryptoKeyPrimaryVersion. Keys with purpose ENCRYPT_DECRYPT may have a primary. For other keys, this field will be omitted. -
purpose
(type:String.t
, default:nil
) - Immutable. The immutable purpose of this CryptoKey. -
rotationPeriod
(type:String.t
, default:nil
) - next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. -
versionTemplate
(type:GoogleApi.CloudKMS.V1.Model.CryptoKeyVersionTemplate.t
, default:nil
) - A template describing settings for new CryptoKeyVersion instances. The properties of new CryptoKeyVersion instances created by either CreateCryptoKeyVersion or auto-rotation are controlled by this template.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Specs
t() :: %GoogleApi.CloudKMS.V1.Model.CryptoKey{ createTime: DateTime.t() | nil, destroyScheduledDuration: String.t() | nil, importOnly: boolean() | nil, labels: map() | nil, name: String.t() | nil, nextRotationTime: DateTime.t() | nil, primary: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t() | nil, purpose: String.t() | nil, rotationPeriod: String.t() | nil, versionTemplate: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersionTemplate.t() | nil }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.