GoogleApi.DNS.V1.Model.DnsKey (google_api_dns v0.24.0) View Source

A DNSSEC key pair.


  • algorithm (type: String.t, default: nil) - String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.
  • creationTime (type: String.t, default: nil) - The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.
  • description (type: String.t, default: nil) - A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.
  • digests (type: list(GoogleApi.DNS.V1.Model.DnsKeyDigest.t), default: nil) - Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.
  • id (type: String.t, default: nil) - Unique identifier for the resource; defined by the server (output only).
  • isActive (type: boolean(), default: nil) - Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.
  • keyLength (type: integer(), default: nil) - Length of the key in bits. Specified at creation time, and then immutable.
  • keyTag (type: integer(), default: nil) - The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.
  • kind (type: String.t, default: dns#dnsKey) -
  • publicKey (type: String.t, default: nil) - Base64 encoded public half of this key. Output only.
  • type (type: String.t, default: nil) - One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.DNS.V1.Model.DnsKey{
  algorithm: String.t() | nil,
  creationTime: String.t() | nil,
  description: String.t() | nil,
  digests: [GoogleApi.DNS.V1.Model.DnsKeyDigest.t()] | nil,
  id: String.t() | nil,
  isActive: boolean() | nil,
  keyLength: integer() | nil,
  keyTag: integer() | nil,
  kind: String.t() | nil,
  publicKey: String.t() | nil,
  type: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.