CustomDomainMetadata

import type { CustomDomainMetadata } from "https://googleapis.deno.dev/v1/firebasehosting:v1.ts";

Metadata associated with aCustomDomain operation.

interface CustomDomainMetadata {

certState?:

| "CERT_STATE_UNSPECIFIED"

| "CERT_PREPARING"

| "CERT_VALIDATING"

| "CERT_PROPAGATING"

| "CERT_ACTIVE"

| "CERT_EXPIRING_SOON"

| "CERT_EXPIRED";

hostState?:

| "HOST_STATE_UNSPECIFIED"

| "HOST_UNHOSTED"

| "HOST_UNREACHABLE"

| "HOST_MISMATCH"

| "HOST_CONFLICT"

| "HOST_ACTIVE";

issues?: Status[];

liveMigrationSteps?: LiveMigrationStep[];

ownershipState?:

| "OWNERSHIP_STATE_UNSPECIFIED"

| "OWNERSHIP_MISSING"

| "OWNERSHIP_UNREACHABLE"

| "OWNERSHIP_MISMATCH"

| "OWNERSHIP_CONFLICT"

| "OWNERSHIP_PENDING"

| "OWNERSHIP_ACTIVE";

quickSetupUpdates?: DnsUpdates;

}

§Properties

[src]

The CertState of the domain name's SSL certificate.

[src]

The HostState of the domain name this CustomDomain refers to.

issues?: Status[]

[src]

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?: LiveMigrationStep[]

[src]

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 the ownershipState to be OWNERSHIP_ACTIVE and the certState to be CERT_ACTIVE before sending traffic to Hosting.

[src]

The OwnershipState of the domain name this CustomDomain refers to.

quickSetupUpdates?: DnsUpdates

[src]

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 and AAAA: 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 existing CAA 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 the liveMigrationSteps first, before making the remaining updates in this field.