google_api_cloud_kms v0.8.0 GoogleApi.CloudKMS.V1.Model.CryptoKey View Source
A CryptoKey represents a logical key that can be used for cryptographic operations.
A CryptoKey is made up of one or more versions, which represent the actual key material used in cryptographic operations.
Attributes
- createTime (DateTime.t): Output only. The time at which this CryptoKey was created. Defaults to
nil
. - labels (map()): Labels with user-defined metadata. For more information, see
Labeling Keys. Defaults to
nil
. - name (String.t): Output only. The resource name for this CryptoKey in the format
projects/*/locations/*/keyRings/*/cryptoKeys/*
. Defaults tonil
. - nextRotationTime (DateTime.t): At next_rotation_time, the Key Management Service will automatically:
- Create a new version of this CryptoKey.
- 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. Defaults to nil
.
- primary (GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t): 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.
All keys with purpose
ENCRYPT_DECRYPT have a
primary. For other keys, this field will be omitted. Defaults to nil
.
- purpose (String.t): The immutable purpose of this CryptoKey. Defaults to
nil
. - rotationPeriod (String.t): next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least one day.
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. Defaults to nil
.
- versionTemplate (GoogleApi.CloudKMS.V1.Model.CryptoKeyVersionTemplate.t): 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. Defaults to
nil
.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.CloudKMS.V1.Model.CryptoKey{
createTime: DateTime.t(),
labels: map(),
name: String.t(),
nextRotationTime: DateTime.t(),
primary: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t(),
purpose: String.t(),
rotationPeriod: String.t(),
versionTemplate: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersionTemplate.t()
}
t() :: %GoogleApi.CloudKMS.V1.Model.CryptoKey{ createTime: DateTime.t(), labels: map(), name: String.t(), nextRotationTime: DateTime.t(), primary: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t(), purpose: String.t(), rotationPeriod: String.t(), versionTemplate: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersionTemplate.t() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.