gcp.firebase.HostingCustomDomain
Explore with Pulumi AI
Example Usage
Firebasehosting Customdomain Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.firebase.HostingCustomDomain("default", {
project: "my-project-name",
siteId: "site-id",
customDomain: "custom.domain.com",
});
import pulumi
import pulumi_gcp as gcp
default = gcp.firebase.HostingCustomDomain("default",
project="my-project-name",
site_id="site-id",
custom_domain="custom.domain.com")
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firebase"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := firebase.NewHostingCustomDomain(ctx, "default", &firebase.HostingCustomDomainArgs{
Project: pulumi.String("my-project-name"),
SiteId: pulumi.String("site-id"),
CustomDomain: pulumi.String("custom.domain.com"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Firebase.HostingCustomDomain("default", new()
{
Project = "my-project-name",
SiteId = "site-id",
CustomDomain = "custom.domain.com",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.HostingCustomDomain;
import com.pulumi.gcp.firebase.HostingCustomDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HostingCustomDomain("default", HostingCustomDomainArgs.builder()
.project("my-project-name")
.siteId("site-id")
.customDomain("custom.domain.com")
.build());
}
}
resources:
default:
type: gcp:firebase:HostingCustomDomain
properties:
project: my-project-name
siteId: site-id
customDomain: custom.domain.com
Firebasehosting Customdomain Full
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.firebase.HostingSite("default", {
project: "my-project-name",
siteId: "site-id-full",
});
const defaultHostingCustomDomain = new gcp.firebase.HostingCustomDomain("default", {
project: "my-project-name",
siteId: _default.siteId,
customDomain: "source.domain.com",
certPreference: "GROUPED",
redirectTarget: "destination.domain.com",
waitDnsVerification: false,
});
import pulumi
import pulumi_gcp as gcp
default = gcp.firebase.HostingSite("default",
project="my-project-name",
site_id="site-id-full")
default_hosting_custom_domain = gcp.firebase.HostingCustomDomain("default",
project="my-project-name",
site_id=default.site_id,
custom_domain="source.domain.com",
cert_preference="GROUPED",
redirect_target="destination.domain.com",
wait_dns_verification=False)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firebase"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := firebase.NewHostingSite(ctx, "default", &firebase.HostingSiteArgs{
Project: pulumi.String("my-project-name"),
SiteId: pulumi.String("site-id-full"),
})
if err != nil {
return err
}
_, err = firebase.NewHostingCustomDomain(ctx, "default", &firebase.HostingCustomDomainArgs{
Project: pulumi.String("my-project-name"),
SiteId: _default.SiteId,
CustomDomain: pulumi.String("source.domain.com"),
CertPreference: pulumi.String("GROUPED"),
RedirectTarget: pulumi.String("destination.domain.com"),
WaitDnsVerification: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Firebase.HostingSite("default", new()
{
Project = "my-project-name",
SiteId = "site-id-full",
});
var defaultHostingCustomDomain = new Gcp.Firebase.HostingCustomDomain("default", new()
{
Project = "my-project-name",
SiteId = @default.SiteId,
CustomDomain = "source.domain.com",
CertPreference = "GROUPED",
RedirectTarget = "destination.domain.com",
WaitDnsVerification = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.HostingSite;
import com.pulumi.gcp.firebase.HostingSiteArgs;
import com.pulumi.gcp.firebase.HostingCustomDomain;
import com.pulumi.gcp.firebase.HostingCustomDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HostingSite("default", HostingSiteArgs.builder()
.project("my-project-name")
.siteId("site-id-full")
.build());
var defaultHostingCustomDomain = new HostingCustomDomain("defaultHostingCustomDomain", HostingCustomDomainArgs.builder()
.project("my-project-name")
.siteId(default_.siteId())
.customDomain("source.domain.com")
.certPreference("GROUPED")
.redirectTarget("destination.domain.com")
.waitDnsVerification(false)
.build());
}
}
resources:
default:
type: gcp:firebase:HostingSite
properties:
project: my-project-name
siteId: site-id-full
defaultHostingCustomDomain:
type: gcp:firebase:HostingCustomDomain
name: default
properties:
project: my-project-name
siteId: ${default.siteId}
customDomain: source.domain.com
certPreference: GROUPED
redirectTarget: destination.domain.com
waitDnsVerification: false
Firebasehosting Customdomain Cloud Run
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const _default = new gcp.firebase.HostingSite("default", {
project: "my-project-name",
siteId: "site-id",
});
const defaultService = new gcp.cloudrunv2.Service("default", {
project: "my-project-name",
name: "cloud-run-service-via-hosting",
location: "us-central1",
ingress: "INGRESS_TRAFFIC_ALL",
template: {
containers: [{
image: "us-docker.pkg.dev/cloudrun/container/hello",
}],
},
deletionProtection: true,
});
const defaultHostingVersion = new gcp.firebase.HostingVersion("default", {
siteId: _default.siteId,
config: {
rewrites: [{
glob: "/hello/**",
run: {
serviceId: defaultService.name,
region: defaultService.location,
},
}],
},
});
const defaultHostingRelease = new gcp.firebase.HostingRelease("default", {
siteId: _default.siteId,
versionName: defaultHostingVersion.name,
message: "Cloud Run Integration",
});
const defaultHostingCustomDomain = new gcp.firebase.HostingCustomDomain("default", {
project: "my-project-name",
siteId: _default.siteId,
customDomain: "run.custom.domain.com",
waitDnsVerification: false,
});
import pulumi
import pulumi_gcp as gcp
default = gcp.firebase.HostingSite("default",
project="my-project-name",
site_id="site-id")
default_service = gcp.cloudrunv2.Service("default",
project="my-project-name",
name="cloud-run-service-via-hosting",
location="us-central1",
ingress="INGRESS_TRAFFIC_ALL",
template={
"containers": [{
"image": "us-docker.pkg.dev/cloudrun/container/hello",
}],
},
deletion_protection=True)
default_hosting_version = gcp.firebase.HostingVersion("default",
site_id=default.site_id,
config={
"rewrites": [{
"glob": "/hello/**",
"run": {
"service_id": default_service.name,
"region": default_service.location,
},
}],
})
default_hosting_release = gcp.firebase.HostingRelease("default",
site_id=default.site_id,
version_name=default_hosting_version.name,
message="Cloud Run Integration")
default_hosting_custom_domain = gcp.firebase.HostingCustomDomain("default",
project="my-project-name",
site_id=default.site_id,
custom_domain="run.custom.domain.com",
wait_dns_verification=False)
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/cloudrunv2"
"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/firebase"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := firebase.NewHostingSite(ctx, "default", &firebase.HostingSiteArgs{
Project: pulumi.String("my-project-name"),
SiteId: pulumi.String("site-id"),
})
if err != nil {
return err
}
defaultService, err := cloudrunv2.NewService(ctx, "default", &cloudrunv2.ServiceArgs{
Project: pulumi.String("my-project-name"),
Name: pulumi.String("cloud-run-service-via-hosting"),
Location: pulumi.String("us-central1"),
Ingress: pulumi.String("INGRESS_TRAFFIC_ALL"),
Template: &cloudrunv2.ServiceTemplateArgs{
Containers: cloudrunv2.ServiceTemplateContainerArray{
&cloudrunv2.ServiceTemplateContainerArgs{
Image: pulumi.String("us-docker.pkg.dev/cloudrun/container/hello"),
},
},
},
DeletionProtection: pulumi.Bool(true),
})
if err != nil {
return err
}
defaultHostingVersion, err := firebase.NewHostingVersion(ctx, "default", &firebase.HostingVersionArgs{
SiteId: _default.SiteId,
Config: &firebase.HostingVersionConfigArgs{
Rewrites: firebase.HostingVersionConfigRewriteArray{
&firebase.HostingVersionConfigRewriteArgs{
Glob: pulumi.String("/hello/**"),
Run: &firebase.HostingVersionConfigRewriteRunArgs{
ServiceId: defaultService.Name,
Region: defaultService.Location,
},
},
},
},
})
if err != nil {
return err
}
_, err = firebase.NewHostingRelease(ctx, "default", &firebase.HostingReleaseArgs{
SiteId: _default.SiteId,
VersionName: defaultHostingVersion.Name,
Message: pulumi.String("Cloud Run Integration"),
})
if err != nil {
return err
}
_, err = firebase.NewHostingCustomDomain(ctx, "default", &firebase.HostingCustomDomainArgs{
Project: pulumi.String("my-project-name"),
SiteId: _default.SiteId,
CustomDomain: pulumi.String("run.custom.domain.com"),
WaitDnsVerification: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var @default = new Gcp.Firebase.HostingSite("default", new()
{
Project = "my-project-name",
SiteId = "site-id",
});
var defaultService = new Gcp.CloudRunV2.Service("default", new()
{
Project = "my-project-name",
Name = "cloud-run-service-via-hosting",
Location = "us-central1",
Ingress = "INGRESS_TRAFFIC_ALL",
Template = new Gcp.CloudRunV2.Inputs.ServiceTemplateArgs
{
Containers = new[]
{
new Gcp.CloudRunV2.Inputs.ServiceTemplateContainerArgs
{
Image = "us-docker.pkg.dev/cloudrun/container/hello",
},
},
},
DeletionProtection = true,
});
var defaultHostingVersion = new Gcp.Firebase.HostingVersion("default", new()
{
SiteId = @default.SiteId,
Config = new Gcp.Firebase.Inputs.HostingVersionConfigArgs
{
Rewrites = new[]
{
new Gcp.Firebase.Inputs.HostingVersionConfigRewriteArgs
{
Glob = "/hello/**",
Run = new Gcp.Firebase.Inputs.HostingVersionConfigRewriteRunArgs
{
ServiceId = defaultService.Name,
Region = defaultService.Location,
},
},
},
},
});
var defaultHostingRelease = new Gcp.Firebase.HostingRelease("default", new()
{
SiteId = @default.SiteId,
VersionName = defaultHostingVersion.Name,
Message = "Cloud Run Integration",
});
var defaultHostingCustomDomain = new Gcp.Firebase.HostingCustomDomain("default", new()
{
Project = "my-project-name",
SiteId = @default.SiteId,
CustomDomain = "run.custom.domain.com",
WaitDnsVerification = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.HostingSite;
import com.pulumi.gcp.firebase.HostingSiteArgs;
import com.pulumi.gcp.cloudrunv2.Service;
import com.pulumi.gcp.cloudrunv2.ServiceArgs;
import com.pulumi.gcp.cloudrunv2.inputs.ServiceTemplateArgs;
import com.pulumi.gcp.firebase.HostingVersion;
import com.pulumi.gcp.firebase.HostingVersionArgs;
import com.pulumi.gcp.firebase.inputs.HostingVersionConfigArgs;
import com.pulumi.gcp.firebase.HostingRelease;
import com.pulumi.gcp.firebase.HostingReleaseArgs;
import com.pulumi.gcp.firebase.HostingCustomDomain;
import com.pulumi.gcp.firebase.HostingCustomDomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var default_ = new HostingSite("default", HostingSiteArgs.builder()
.project("my-project-name")
.siteId("site-id")
.build());
var defaultService = new Service("defaultService", ServiceArgs.builder()
.project("my-project-name")
.name("cloud-run-service-via-hosting")
.location("us-central1")
.ingress("INGRESS_TRAFFIC_ALL")
.template(ServiceTemplateArgs.builder()
.containers(ServiceTemplateContainerArgs.builder()
.image("us-docker.pkg.dev/cloudrun/container/hello")
.build())
.build())
.deletionProtection(true)
.build());
var defaultHostingVersion = new HostingVersion("defaultHostingVersion", HostingVersionArgs.builder()
.siteId(default_.siteId())
.config(HostingVersionConfigArgs.builder()
.rewrites(HostingVersionConfigRewriteArgs.builder()
.glob("/hello/**")
.run(HostingVersionConfigRewriteRunArgs.builder()
.serviceId(defaultService.name())
.region(defaultService.location())
.build())
.build())
.build())
.build());
var defaultHostingRelease = new HostingRelease("defaultHostingRelease", HostingReleaseArgs.builder()
.siteId(default_.siteId())
.versionName(defaultHostingVersion.name())
.message("Cloud Run Integration")
.build());
var defaultHostingCustomDomain = new HostingCustomDomain("defaultHostingCustomDomain", HostingCustomDomainArgs.builder()
.project("my-project-name")
.siteId(default_.siteId())
.customDomain("run.custom.domain.com")
.waitDnsVerification(false)
.build());
}
}
resources:
default:
type: gcp:firebase:HostingSite
properties:
project: my-project-name
siteId: site-id
defaultService:
type: gcp:cloudrunv2:Service
name: default
properties:
project: my-project-name
name: cloud-run-service-via-hosting
location: us-central1
ingress: INGRESS_TRAFFIC_ALL
template:
containers:
- image: us-docker.pkg.dev/cloudrun/container/hello
deletionProtection: true
defaultHostingVersion:
type: gcp:firebase:HostingVersion
name: default
properties:
siteId: ${default.siteId}
config:
rewrites:
- glob: /hello/**
run:
serviceId: ${defaultService.name}
region: ${defaultService.location}
defaultHostingRelease:
type: gcp:firebase:HostingRelease
name: default
properties:
siteId: ${default.siteId}
versionName: ${defaultHostingVersion.name}
message: Cloud Run Integration
defaultHostingCustomDomain:
type: gcp:firebase:HostingCustomDomain
name: default
properties:
project: my-project-name
siteId: ${default.siteId}
customDomain: run.custom.domain.com
waitDnsVerification: false
Create HostingCustomDomain Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HostingCustomDomain(name: string, args: HostingCustomDomainArgs, opts?: CustomResourceOptions);
@overload
def HostingCustomDomain(resource_name: str,
args: HostingCustomDomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HostingCustomDomain(resource_name: str,
opts: Optional[ResourceOptions] = None,
custom_domain: Optional[str] = None,
site_id: Optional[str] = None,
cert_preference: Optional[str] = None,
project: Optional[str] = None,
redirect_target: Optional[str] = None,
wait_dns_verification: Optional[bool] = None)
func NewHostingCustomDomain(ctx *Context, name string, args HostingCustomDomainArgs, opts ...ResourceOption) (*HostingCustomDomain, error)
public HostingCustomDomain(string name, HostingCustomDomainArgs args, CustomResourceOptions? opts = null)
public HostingCustomDomain(String name, HostingCustomDomainArgs args)
public HostingCustomDomain(String name, HostingCustomDomainArgs args, CustomResourceOptions options)
type: gcp:firebase:HostingCustomDomain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args HostingCustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args HostingCustomDomainArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args HostingCustomDomainArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HostingCustomDomainArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HostingCustomDomainArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var hostingCustomDomainResource = new Gcp.Firebase.HostingCustomDomain("hostingCustomDomainResource", new()
{
CustomDomain = "string",
SiteId = "string",
CertPreference = "string",
Project = "string",
RedirectTarget = "string",
WaitDnsVerification = false,
});
example, err := firebase.NewHostingCustomDomain(ctx, "hostingCustomDomainResource", &firebase.HostingCustomDomainArgs{
CustomDomain: pulumi.String("string"),
SiteId: pulumi.String("string"),
CertPreference: pulumi.String("string"),
Project: pulumi.String("string"),
RedirectTarget: pulumi.String("string"),
WaitDnsVerification: pulumi.Bool(false),
})
var hostingCustomDomainResource = new HostingCustomDomain("hostingCustomDomainResource", HostingCustomDomainArgs.builder()
.customDomain("string")
.siteId("string")
.certPreference("string")
.project("string")
.redirectTarget("string")
.waitDnsVerification(false)
.build());
hosting_custom_domain_resource = gcp.firebase.HostingCustomDomain("hostingCustomDomainResource",
custom_domain="string",
site_id="string",
cert_preference="string",
project="string",
redirect_target="string",
wait_dns_verification=False)
const hostingCustomDomainResource = new gcp.firebase.HostingCustomDomain("hostingCustomDomainResource", {
customDomain: "string",
siteId: "string",
certPreference: "string",
project: "string",
redirectTarget: "string",
waitDnsVerification: false,
});
type: gcp:firebase:HostingCustomDomain
properties:
certPreference: string
customDomain: string
project: string
redirectTarget: string
siteId: string
waitDnsVerification: false
HostingCustomDomain Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The HostingCustomDomain resource accepts the following input properties:
- Custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - Site
Id string - The ID of the site in which to create this custom domain association.
- Cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - Wait
Dns boolVerification
- Custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - Site
Id string - The ID of the site in which to create this custom domain association.
- Cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - Wait
Dns boolVerification
- custom
Domain String - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - site
Id String - The ID of the site in which to create this custom domain association.
- cert
Preference String - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- redirect
Target String - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - wait
Dns BooleanVerification
- custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - site
Id string - The ID of the site in which to create this custom domain association.
- cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - wait
Dns booleanVerification
- custom_
domain str - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - site_
id str - The ID of the site in which to create this custom domain association.
- cert_
preference str - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- redirect_
target str - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - wait_
dns_ boolverification
- custom
Domain String - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - site
Id String - The ID of the site in which to create this custom domain association.
- cert
Preference String - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- redirect
Target String - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - wait
Dns BooleanVerification
Outputs
All input properties are implicitly available as output properties. Additionally, the HostingCustomDomain resource produces the following output properties:
- Certs
List<Hosting
Custom Domain Cert> - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - Create
Time string - The
CustomDomain
's create time. - Delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - Etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - Expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - Host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - Id string
- The provider-assigned unique ID for this managed resource.
- Issues
List<Hosting
Custom Domain Issue> - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - Name string
- The fully-qualified name of the
CustomDomain
. - Ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - Reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- Required
Dns List<HostingUpdates Custom Domain Required Dns Update> - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- Update
Time string - The last time the
CustomDomain
was updated.
- Certs
[]Hosting
Custom Domain Cert - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - Create
Time string - The
CustomDomain
's create time. - Delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - Etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - Expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - Host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - Id string
- The provider-assigned unique ID for this managed resource.
- Issues
[]Hosting
Custom Domain Issue - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - Name string
- The fully-qualified name of the
CustomDomain
. - Ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - Reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- Required
Dns []HostingUpdates Custom Domain Required Dns Update - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- Update
Time string - The last time the
CustomDomain
was updated.
- certs
List<Hosting
Custom Domain Cert> - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time String - The
CustomDomain
's create time. - delete
Time String - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag String
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time String - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State String - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - id String
- The provider-assigned unique ID for this managed resource.
- issues
List<Hosting
Custom Domain Issue> - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name String
- The fully-qualified name of the
CustomDomain
. - ownership
State String - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - reconciling Boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- required
Dns List<HostingUpdates Custom Domain Required Dns Update> - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- update
Time String - The last time the
CustomDomain
was updated.
- certs
Hosting
Custom Domain Cert[] - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time string - The
CustomDomain
's create time. - delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - id string
- The provider-assigned unique ID for this managed resource.
- issues
Hosting
Custom Domain Issue[] - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name string
- The fully-qualified name of the
CustomDomain
. - ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - reconciling boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- required
Dns HostingUpdates Custom Domain Required Dns Update[] - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- update
Time string - The last time the
CustomDomain
was updated.
- certs
Sequence[Hosting
Custom Domain Cert] - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create_
time str - The
CustomDomain
's create time. - delete_
time str - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag str
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire_
time str - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host_
state str - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - id str
- The provider-assigned unique ID for this managed resource.
- issues
Sequence[Hosting
Custom Domain Issue] - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name str
- The fully-qualified name of the
CustomDomain
. - ownership_
state str - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- required_
dns_ Sequence[Hostingupdates Custom Domain Required Dns Update] - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- update_
time str - The last time the
CustomDomain
was updated.
- certs List<Property Map>
- The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time String - The
CustomDomain
's create time. - delete
Time String - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag String
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time String - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State String - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - id String
- The provider-assigned unique ID for this managed resource.
- issues List<Property Map>
- A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name String
- The fully-qualified name of the
CustomDomain
. - ownership
State String - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - reconciling Boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- required
Dns List<Property Map>Updates - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- update
Time String - The last time the
CustomDomain
was updated.
Look up Existing HostingCustomDomain Resource
Get an existing HostingCustomDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: HostingCustomDomainState, opts?: CustomResourceOptions): HostingCustomDomain
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cert_preference: Optional[str] = None,
certs: Optional[Sequence[HostingCustomDomainCertArgs]] = None,
create_time: Optional[str] = None,
custom_domain: Optional[str] = None,
delete_time: Optional[str] = None,
etag: Optional[str] = None,
expire_time: Optional[str] = None,
host_state: Optional[str] = None,
issues: Optional[Sequence[HostingCustomDomainIssueArgs]] = None,
name: Optional[str] = None,
ownership_state: Optional[str] = None,
project: Optional[str] = None,
reconciling: Optional[bool] = None,
redirect_target: Optional[str] = None,
required_dns_updates: Optional[Sequence[HostingCustomDomainRequiredDnsUpdateArgs]] = None,
site_id: Optional[str] = None,
update_time: Optional[str] = None,
wait_dns_verification: Optional[bool] = None) -> HostingCustomDomain
func GetHostingCustomDomain(ctx *Context, name string, id IDInput, state *HostingCustomDomainState, opts ...ResourceOption) (*HostingCustomDomain, error)
public static HostingCustomDomain Get(string name, Input<string> id, HostingCustomDomainState? state, CustomResourceOptions? opts = null)
public static HostingCustomDomain get(String name, Output<String> id, HostingCustomDomainState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - Certs
List<Hosting
Custom Domain Cert> - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - Create
Time string - The
CustomDomain
's create time. - Custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - Delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - Etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - Expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - Host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - Issues
List<Hosting
Custom Domain Issue> - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - Name string
- The fully-qualified name of the
CustomDomain
. - Ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- Redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - Required
Dns List<HostingUpdates Custom Domain Required Dns Update> - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- Site
Id string - The ID of the site in which to create this custom domain association.
- Update
Time string - The last time the
CustomDomain
was updated. - Wait
Dns boolVerification
- Cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - Certs
[]Hosting
Custom Domain Cert Args - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - Create
Time string - The
CustomDomain
's create time. - Custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - Delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - Etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - Expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - Host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - Issues
[]Hosting
Custom Domain Issue Args - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - Name string
- The fully-qualified name of the
CustomDomain
. - Ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- Redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - Required
Dns []HostingUpdates Custom Domain Required Dns Update Args - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- Site
Id string - The ID of the site in which to create this custom domain association.
- Update
Time string - The last time the
CustomDomain
was updated. - Wait
Dns boolVerification
- cert
Preference String - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - certs
List<Hosting
Custom Domain Cert> - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time String - The
CustomDomain
's create time. - custom
Domain String - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - delete
Time String - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag String
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time String - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State String - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - issues
List<Hosting
Custom Domain Issue> - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name String
- The fully-qualified name of the
CustomDomain
. - ownership
State String - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- reconciling Boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- redirect
Target String - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - required
Dns List<HostingUpdates Custom Domain Required Dns Update> - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- site
Id String - The ID of the site in which to create this custom domain association.
- update
Time String - The last time the
CustomDomain
was updated. - wait
Dns BooleanVerification
- cert
Preference string - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - certs
Hosting
Custom Domain Cert[] - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time string - The
CustomDomain
's create time. - custom
Domain string - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - delete
Time string - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag string
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time string - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State string - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - issues
Hosting
Custom Domain Issue[] - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name string
- The fully-qualified name of the
CustomDomain
. - ownership
State string - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- reconciling boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- redirect
Target string - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - required
Dns HostingUpdates Custom Domain Required Dns Update[] - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- site
Id string - The ID of the site in which to create this custom domain association.
- update
Time string - The last time the
CustomDomain
was updated. - wait
Dns booleanVerification
- cert_
preference str - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - certs
Sequence[Hosting
Custom Domain Cert Args] - The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create_
time str - The
CustomDomain
's create time. - custom_
domain str - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - delete_
time str - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag str
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire_
time str - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host_
state str - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - issues
Sequence[Hosting
Custom Domain Issue Args] - A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name str
- The fully-qualified name of the
CustomDomain
. - ownership_
state str - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - project str
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- reconciling bool
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- redirect_
target str - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - required_
dns_ Sequence[Hostingupdates Custom Domain Required Dns Update Args] - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- site_
id str - The ID of the site in which to create this custom domain association.
- update_
time str - The last time the
CustomDomain
was updated. - wait_
dns_ boolverification
- cert
Preference String - A field that lets you specify which SSL certificate type Hosting creates
for your domain name. Spark plan
CustomDomain
s only have access to theGROUPED
cert type, while Blaze plan can select any option. Possible values are:GROUPED
,PROJECT_GROUPED
,DEDICATED
. - certs List<Property Map>
- The SSL certificate Hosting has for this
CustomDomain
's domain name. For newCustomDomain
s, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check thestate
field for more. Structure is documented below. - create
Time String - The
CustomDomain
's create time. - custom
Domain String - The ID of the
CustomDomain
, which is the domain name you'd like to use with Firebase Hosting. - delete
Time String - The time the
CustomDomain
was deleted; null forCustomDomains
that haven't been deleted. DeletedCustomDomains
persist for approximately 30 days, after which time Hosting removes them completely. - etag String
- A string that represents the current state of the
CustomDomain
and allows you to confirm its initial state in requests that would modify it. - expire
Time String - The minimum time before a soft-deleted
CustomDomain
is completely removed from Hosting; null forCustomDomains
that haven't been deleted. - host
State String - The host state of your domain name. Host state is determined by checking each
IP address associated with your domain name to see if it's serving
Hosting content.
HOST_UNHOSTED:
Your
CustomDomain
's domain name isn't associated with any IP addresses. HOST_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See yourCustomDomain
'sissues
field for more details. HOST_MISMATCH: YourCustomDomain
's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: YourCustomDomain
's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, removeA
andAAAA
records related to non-Hosting services. HOST_ACTIVE: All requests against yourCustomDomain
's domain name are served by Hosting. If theCustomDomain
'sOwnershipState
is alsoACTIVE
, Hosting serves your Hosting Site's content on the domain name. - issues List<Property Map>
- A set of errors Hosting systems encountered when trying to establish
Hosting's ability to serve secure content for your domain name. Resolve
these issues to ensure your
CustomDomain
behaves properly. Structure is documented below. - name String
- The fully-qualified name of the
CustomDomain
. - ownership
State String - The ownership state of your domain name. Ownership is determined at a
Firebase project level, and established by adding
TXT
records to your domain name's DNS records. Ownership cascades to subdomains. Granting a project ownership offoo.com
also grants that project ownership overbar.foo.com
, unless you add specificTXT
records tobar.foo.com
that grant a different project ownership. If yourCustomDomain
is in anOwnershipState
other thanOWNERSHIP_ACTIVE
for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete theCustomDomain
. OWNERSHIP_MISSING: YourCustomDomain
's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: YourCustomDomain
's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See yourCustomDomain
'sissues
field for more details. OWNERSHIP_MISMATCH: YourCustomDomain
's domain name is owned by another Firebase project. Remove the conflictingTXT
records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: YourCustomDomain
's domain name has conflictingTXT
records that indicate ownership by both your current Firebase project and another project. Remove the other project's ownership records to grant the current project ownership. OWNERSHIP_PENDING: YourCustomDomain
's DNS records are configured correctly. Hosting will transfer ownership of your domain to thisCustomDomain
within 24 hours. OWNERSHIP_ACTIVE: YourCustomDomain
's domain name hasTXT
records that grant its project permission to act on its behalf. - project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- reconciling Boolean
- if true, indicates that Hosting's systems are attmepting to
make the
CustomDomain
's state match your preferred state. This is most frequentlytrue
when initially provisioning aCustomDomain
or when creating a new SSL certificate to match an updatedcert_preference
- redirect
Target String - A domain name that this CustomDomain should direct traffic towards. If
specified, Hosting will respond to requests against this CustomDomain
with an HTTP 301 code, and route traffic to the specified
redirect_target
instead. - required
Dns List<Property Map>Updates - A set of updates you should make to the domain name's DNS records to let Hosting serve secure content on its behalf. Structure is documented below.
- site
Id String - The ID of the site in which to create this custom domain association.
- update
Time String - The last time the
CustomDomain
was updated. - wait
Dns BooleanVerification
Supporting Types
HostingCustomDomainCert, HostingCustomDomainCertArgs
- State string
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - Type string
- The record's type, which determines what data the record contains.
- Verification
Hosting
Custom Domain Cert Verification - A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
- State string
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - Type string
- The record's type, which determines what data the record contains.
- Verification
Hosting
Custom Domain Cert Verification - A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
- state String
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - type String
- The record's type, which determines what data the record contains.
- verification
Hosting
Custom Domain Cert Verification - A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
- state string
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - type string
- The record's type, which determines what data the record contains.
- verification
Hosting
Custom Domain Cert Verification - A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
- state str
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - type str
- The record's type, which determines what data the record contains.
- verification
Hosting
Custom Domain Cert Verification - A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
- state String
- The state of the certificate. Only the
CERT_ACTIVE
andCERT_EXPIRING_SOON
states provide SSL coverage for a domain name. If the state isPROPAGATING
and Hosting had an active cert for the domain name before, that formerly-active cert provides SSL coverage for the domain name until the current cert propagates. - type String
- The record's type, which determines what data the record contains.
- verification Property Map
- A set of ACME challenges you can add to your DNS records or existing, non-Hosting hosting provider to allow Hosting to create an SSL certificate for your domain name before you point traffic toward hosting. You can use thse challenges as part of a zero downtime transition from your old provider to Hosting. Structure is documented below.
HostingCustomDomainCertVerification, HostingCustomDomainCertVerificationArgs
- Dns
Hosting
Custom Domain Cert Verification Dns - A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - Http
Hosting
Custom Domain Cert Verification Http - A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
- Dns
Hosting
Custom Domain Cert Verification Dns - A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - Http
Hosting
Custom Domain Cert Verification Http - A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
- dns
Hosting
Custom Domain Cert Verification Dns - A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - http
Hosting
Custom Domain Cert Verification Http - A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
- dns
Hosting
Custom Domain Cert Verification Dns - A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - http
Hosting
Custom Domain Cert Verification Http - A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
- dns
Hosting
Custom Domain Cert Verification Dns - A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - http
Hosting
Custom Domain Cert Verification Http - A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
- dns Property Map
- A
TXT
record to add to your DNS records that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below. - http Property Map
- A file to add to your existing, non-Hosting hosting service that confirms your intent to let Hosting create an SSL cert for your domain name. Structure is documented below.
HostingCustomDomainCertVerificationDns, HostingCustomDomainCertVerificationDnsArgs
- Check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- Desireds
List<Hosting
Custom Domain Cert Verification Dns Desired> - A text string to serve at the path.
- Discovereds
List<Hosting
Custom Domain Cert Verification Dns Discovered> - Whether Hosting was able to find the required file contents on the specified path during its last check.
- Check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- Desireds
[]Hosting
Custom Domain Cert Verification Dns Desired - A text string to serve at the path.
- Discovereds
[]Hosting
Custom Domain Cert Verification Dns Discovered - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time String - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
List<Hosting
Custom Domain Cert Verification Dns Desired> - A text string to serve at the path.
- discovereds
List<Hosting
Custom Domain Cert Verification Dns Discovered> - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
Hosting
Custom Domain Cert Verification Dns Desired[] - A text string to serve at the path.
- discovereds
Hosting
Custom Domain Cert Verification Dns Discovered[] - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check_
time str - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
Sequence[Hosting
Custom Domain Cert Verification Dns Desired] - A text string to serve at the path.
- discovereds
Sequence[Hosting
Custom Domain Cert Verification Dns Discovered] - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time String - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds List<Property Map>
- A text string to serve at the path.
- discovereds List<Property Map>
- Whether Hosting was able to find the required file contents on the specified path during its last check.
HostingCustomDomainCertVerificationDnsDesired, HostingCustomDomainCertVerificationDnsDesiredArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
List<Hosting
Custom Domain Cert Verification Dns Desired Record> - Records on the domain Structure is documented below.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
[]Hosting
Custom Domain Cert Verification Dns Desired Record - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
List<Hosting
Custom Domain Cert Verification Dns Desired Record> - Records on the domain Structure is documented below.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Hosting
Custom Domain Cert Verification Dns Desired Record[] - Records on the domain Structure is documented below.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Sequence[Hosting
Custom Domain Cert Verification Dns Desired Record] - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records List<Property Map>
- Records on the domain Structure is documented below.
HostingCustomDomainCertVerificationDnsDesiredRecord, HostingCustomDomainCertVerificationDnsDesiredRecordArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action string - Indicates the a required action for this record.
- type string
- The record's type, which determines what data the record contains.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata str
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required_
action str - Indicates the a required action for this record.
- type str
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
HostingCustomDomainCertVerificationDnsDiscovered, HostingCustomDomainCertVerificationDnsDiscoveredArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
List<Hosting
Custom Domain Cert Verification Dns Discovered Record> - Records on the domain Structure is documented below.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
[]Hosting
Custom Domain Cert Verification Dns Discovered Record - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
List<Hosting
Custom Domain Cert Verification Dns Discovered Record> - Records on the domain Structure is documented below.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Hosting
Custom Domain Cert Verification Dns Discovered Record[] - Records on the domain Structure is documented below.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Sequence[Hosting
Custom Domain Cert Verification Dns Discovered Record] - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records List<Property Map>
- Records on the domain Structure is documented below.
HostingCustomDomainCertVerificationDnsDiscoveredRecord, HostingCustomDomainCertVerificationDnsDiscoveredRecordArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action string - Indicates the a required action for this record.
- type string
- The record's type, which determines what data the record contains.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata str
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required_
action str - Indicates the a required action for this record.
- type str
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
HostingCustomDomainCertVerificationHttp, HostingCustomDomainCertVerificationHttpArgs
- Desired string
- A text string to serve at the path.
- Discovered string
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- Last
Check stringTime - (Output) The last time Hosting systems checked for the file contents.
- Path string
- The path to the file.
- Desired string
- A text string to serve at the path.
- Discovered string
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- Last
Check stringTime - (Output) The last time Hosting systems checked for the file contents.
- Path string
- The path to the file.
- desired String
- A text string to serve at the path.
- discovered String
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- last
Check StringTime - (Output) The last time Hosting systems checked for the file contents.
- path String
- The path to the file.
- desired string
- A text string to serve at the path.
- discovered string
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- last
Check stringTime - (Output) The last time Hosting systems checked for the file contents.
- path string
- The path to the file.
- desired str
- A text string to serve at the path.
- discovered str
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- last_
check_ strtime - (Output) The last time Hosting systems checked for the file contents.
- path str
- The path to the file.
- desired String
- A text string to serve at the path.
- discovered String
- Whether Hosting was able to find the required file contents on the specified path during its last check.
- last
Check StringTime - (Output) The last time Hosting systems checked for the file contents.
- path String
- The path to the file.
HostingCustomDomainIssue, HostingCustomDomainIssueArgs
HostingCustomDomainRequiredDnsUpdate, HostingCustomDomainRequiredDnsUpdateArgs
- Check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- Desireds
List<Hosting
Custom Domain Required Dns Update Desired> - A text string to serve at the path.
- Discovereds
List<Hosting
Custom Domain Required Dns Update Discovered> - Whether Hosting was able to find the required file contents on the specified path during its last check.
- Check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- Desireds
[]Hosting
Custom Domain Required Dns Update Desired - A text string to serve at the path.
- Discovereds
[]Hosting
Custom Domain Required Dns Update Discovered - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time String - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
List<Hosting
Custom Domain Required Dns Update Desired> - A text string to serve at the path.
- discovereds
List<Hosting
Custom Domain Required Dns Update Discovered> - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time string - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
Hosting
Custom Domain Required Dns Update Desired[] - A text string to serve at the path.
- discovereds
Hosting
Custom Domain Required Dns Update Discovered[] - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check_
time str - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds
Sequence[Hosting
Custom Domain Required Dns Update Desired] - A text string to serve at the path.
- discovereds
Sequence[Hosting
Custom Domain Required Dns Update Discovered] - Whether Hosting was able to find the required file contents on the specified path during its last check.
- check
Time String - (Output) The last time Hosting checked your CustomDomain's DNS records.
- desireds List<Property Map>
- A text string to serve at the path.
- discovereds List<Property Map>
- Whether Hosting was able to find the required file contents on the specified path during its last check.
HostingCustomDomainRequiredDnsUpdateDesired, HostingCustomDomainRequiredDnsUpdateDesiredArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
List<Hosting
Custom Domain Required Dns Update Desired Record> - Records on the domain Structure is documented below.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
[]Hosting
Custom Domain Required Dns Update Desired Record - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
List<Hosting
Custom Domain Required Dns Update Desired Record> - Records on the domain Structure is documented below.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Hosting
Custom Domain Required Dns Update Desired Record[] - Records on the domain Structure is documented below.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Sequence[Hosting
Custom Domain Required Dns Update Desired Record] - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records List<Property Map>
- Records on the domain Structure is documented below.
HostingCustomDomainRequiredDnsUpdateDesiredRecord, HostingCustomDomainRequiredDnsUpdateDesiredRecordArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action string - Indicates the a required action for this record.
- type string
- The record's type, which determines what data the record contains.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata str
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required_
action str - Indicates the a required action for this record.
- type str
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
HostingCustomDomainRequiredDnsUpdateDiscovered, HostingCustomDomainRequiredDnsUpdateDiscoveredArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
List<Hosting
Custom Domain Required Dns Update Discovered Record> - Records on the domain Structure is documented below.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Records
[]Hosting
Custom Domain Required Dns Update Discovered Record - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
List<Hosting
Custom Domain Required Dns Update Discovered Record> - Records on the domain Structure is documented below.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Hosting
Custom Domain Required Dns Update Discovered Record[] - Records on the domain Structure is documented below.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - records
Sequence[Hosting
Custom Domain Required Dns Update Discovered Record] - Records on the domain Structure is documented below.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - records List<Property Map>
- Records on the domain Structure is documented below.
HostingCustomDomainRequiredDnsUpdateDiscoveredRecord, HostingCustomDomainRequiredDnsUpdateDiscoveredRecordArgs
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- Domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - Rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- Required
Action string - Indicates the a required action for this record.
- Type string
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
- domain
Name string - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata string
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action string - Indicates the a required action for this record.
- type string
- The record's type, which determines what data the record contains.
- domain_
name str - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata str
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required_
action str - Indicates the a required action for this record.
- type str
- The record's type, which determines what data the record contains.
- domain
Name String - The domain name the record pertains to, e.g.
foo.bar.com.
. - rdata String
- The data of the record. The meaning of the value depends on record type:
- A and AAAA: IP addresses for the domain name.
- CNAME: Another domain to check for records.
- TXT: Arbitrary text strings associated with the domain name. Hosting uses TXT records to determine a which Firebase Projects have permission to act on the domain name's behalf.
- CAA: The record's flags, tag, and value, e.g.
0 issue "pki.goog"
.
- required
Action String - Indicates the a required action for this record.
- type String
- The record's type, which determines what data the record contains.
Import
CustomDomain can be imported using any of these accepted formats:
projects/{{project}}/sites/{{site_id}}/customDomains/{{custom_domain}}
sites/{{site_id}}/customDomains/{{custom_domain}}
{{project}}/{{site_id}}/{{custom_domain}}
{{site_id}}/{{custom_domain}}
When using the pulumi import
command, CustomDomain can be imported using one of the formats above. For example:
$ pulumi import gcp:firebase/hostingCustomDomain:HostingCustomDomain default projects/{{project}}/sites/{{site_id}}/customDomains/{{custom_domain}}
$ pulumi import gcp:firebase/hostingCustomDomain:HostingCustomDomain default sites/{{site_id}}/customDomains/{{custom_domain}}
$ pulumi import gcp:firebase/hostingCustomDomain:HostingCustomDomain default {{project}}/{{site_id}}/{{custom_domain}}
$ pulumi import gcp:firebase/hostingCustomDomain:HostingCustomDomain default {{site_id}}/{{custom_domain}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-beta
Terraform Provider.