View Source GoogleApi.FirebaseHosting.V1.Model.CustomDomainMetadata (google_api_firebase_hosting v0.17.1)
Metadata associated with aCustomDomain
operation.
Attributes
-
certState
(type:String.t
, default:nil
) - TheCertState
of the domain name's SSL certificate. -
hostState
(type:String.t
, default:nil
) - TheHostState
of the domain name thisCustomDomain
refers to. -
issues
(type:list(GoogleApi.FirebaseHosting.V1.Model.Status.t)
, default:nil
) - A list of issues that are currently preventing Hosting from completing the operation. These are generally DNS-related issues that Hosting encounters when querying a domain name's records or attempting to mint an SSL certificate. -
liveMigrationSteps
(type:list(GoogleApi.FirebaseHosting.V1.Model.LiveMigrationStep.t)
, default:nil
) - A set of DNS record updates and ACME challenges that allow you to transition domain names to Firebase Hosting with zero downtime. These updates allow Hosting to create an SSL certificate and establish ownership for your custom domain before Hosting begins serving traffic on it. If your domain name is already in active use with another provider, add one of the challenges and make the recommended DNS updates. After adding challenges and adjusting DNS records as necessary, wait for theownershipState
to beOWNERSHIP_ACTIVE
and thecertState
to beCERT_ACTIVE
before sending traffic to Hosting. -
ownershipState
(type:String.t
, default:nil
) - TheOwnershipState
of the domain name thisCustomDomain
refers to. -
quickSetupUpdates
(type:GoogleApi.FirebaseHosting.V1.Model.DnsUpdates.t
, default:nil
) - A set of DNS record updates that allow Hosting to serve secure content on your domain name. The record type determines the update's purpose: -A
andAAAA
: Updates your domain name's IP addresses so that they direct traffic to Hosting servers. -TXT
: Updates ownership permissions on your domain name, letting Hosting know that your custom domain's project has permission to perform actions for that domain name. -CAA
: Updates your domain name's list of authorized Certificate Authorities (CAs). Only present if you have existingCAA
records that prohibit Hosting's CA from minting certs for your domain name. These updates include all DNS changes you'll need to get started with Hosting, but, if made all at once, can result in a brief period of downtime for your domain name--while Hosting creates and uploads an SSL cert, for example. If you'd like to add your domain name to Hosting without downtime, complete theliveMigrationSteps
first, before making the remaining updates in this field.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.FirebaseHosting.V1.Model.CustomDomainMetadata{ certState: String.t() | nil, hostState: String.t() | nil, issues: [GoogleApi.FirebaseHosting.V1.Model.Status.t()] | nil, liveMigrationSteps: [GoogleApi.FirebaseHosting.V1.Model.LiveMigrationStep.t()] | nil, ownershipState: String.t() | nil, quickSetupUpdates: GoogleApi.FirebaseHosting.V1.Model.DnsUpdates.t() | nil }