google_api_cloud_kms v0.1.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: null.
  • labels (%{optional(String.t) => String.t}): Labels with user-defined metadata. For more information, see Labeling Keys. Defaults to: null.
  • name (String.t): Output only. The resource name for this CryptoKey in the format `projects//locations//keyRings//cryptoKeys/`. Defaults to: null.
  • nextRotationTime (DateTime.t): 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. Defaults to: null.
  • primary (CryptoKeyVersion): 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. Defaults to: null.
  • purpose (String.t): The immutable purpose of this CryptoKey. Currently, the only acceptable purpose is ENCRYPT_DECRYPT. Defaults to: null.

    • Enum - one of [CRYPTO_KEY_PURPOSE_UNSPECIFIED, ENCRYPT_DECRYPT]
  • 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. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type t() View Source
t() :: %GoogleApi.CloudKMS.V1.Model.CryptoKey{
  createTime: DateTime.t(),
  labels: map(),
  name: any(),
  nextRotationTime: DateTime.t(),
  primary: GoogleApi.CloudKMS.V1.Model.CryptoKeyVersion.t(),
  purpose: any(),
  rotationPeriod: any()
}

Link to this section Functions

Link to this function decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.