HostingCustomDomainState class

Input properties used for looking up and filtering HostingCustomDomain resources.

Constructors

HostingCustomDomainState({Input<String?>? certPreference, Input<List<HostingCustomDomainCert>?>? certs, Input<String?>? createTime, Input<String?>? customDomain, Input<String?>? deleteTime, Input<String?>? deletionPolicy, Input<String?>? etag, Input<String?>? expireTime, Input<String?>? hostState, Input<List<HostingCustomDomainIssue>?>? issues, Input<String?>? name, Input<String?>? ownershipState, Input<String?>? project, Input<bool?>? reconciling, Input<String?>? redirectTarget, Input<List<HostingCustomDomainRequiredDnsUpdate>?>? requiredDnsUpdates, Input<String?>? siteId, Input<String?>? updateTime, Input<bool?>? waitDnsVerification})
Creates a new HostingCustomDomainState. certPreference A field that lets you specify which SSL certificate type Hosting creates certs The SSL certificate Hosting has for this CustomDomain's domain name. createTime The CustomDomain's create time. customDomain The ID of the CustomDomain, which is the domain name you'd like to use with Firebase Hosting. deleteTime The time the CustomDomain was deleted; null for CustomDomains that deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. etag A string that represents the current state of the CustomDomain and expireTime The minimum time before a soft-deleted CustomDomain is completely removed hostState The host state of your domain name. Host state is determined by checking each issues A set of errors Hosting systems encountered when trying to establish name The fully-qualified name of the CustomDomain. ownershipState The ownership state of your domain name. Ownership is determined at a project The ID of the project in which the resource belongs. reconciling if true, indicates that Hosting's systems are attempting to redirectTarget A domain name that this CustomDomain should direct traffic towards. If requiredDnsUpdates A set of updates you should make to the domain name's DNS records to siteId The ID of the site in which to create this custom domain association. updateTime The last time the CustomDomain was updated. waitDnsVerification If true, Terraform will wait for DNS records to be fully resolved on the CustomDomain.
const
HostingCustomDomainState.fromMap(Map<String, dynamic> map)
factory

Properties

certPreference → Input<String?>?
A field that lets you specify which SSL certificate type Hosting creates for your domain name. Spark plan CustomDomains only have access to the GROUPED cert type, while Blaze plan can select any option. Possible values are: GROUPED, PROJECT_GROUPED, DEDICATED.
final
certs → Input<List<HostingCustomDomainCert>?>?
The SSL certificate Hosting has for this CustomDomain's domain name. For new CustomDomains, this often represents Hosting's intent to create a certificate, rather than an actual cert. Check the state field for more. Structure is documented below.
final
createTime → Input<String?>?
The CustomDomain's create time.
final
customDomain → Input<String?>?
The ID of the CustomDomain, which is the domain name you'd like to use with Firebase Hosting.
final
deleteTime → Input<String?>?
The time the CustomDomain was deleted; null for CustomDomains that haven't been deleted. Deleted CustomDomains persist for approximately 30 days, after which time Hosting removes them completely.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
etag → Input<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.
final
expireTime → Input<String?>?
The minimum time before a soft-deleted CustomDomain is completely removed from Hosting; null for CustomDomains that haven't been deleted.
final
hashCode → int
The hash code for this object.
no setterinherited
hostState → Input<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: Your CustomDomain's domain name can't be reached. Hosting services' DNS queries to find your domain name's IP addresses resulted in errors. See your CustomDomain's issues field for more details. HOST_MISMATCH: Your CustomDomain's domain name has IP addresses that don't ultimately resolve to Hosting. HOST_CONFLICT: Your CustomDomain's domain name has IP addresses that resolve to both Hosting and other services. To ensure consistent results, remove A and AAAA records related to non-Hosting services. HOST_ACTIVE: All requests against your CustomDomain's domain name are served by Hosting. If the CustomDomain's OwnershipState is also ACTIVE, Hosting serves your Hosting Site's content on the domain name.
final
issues → Input<List<HostingCustomDomainIssue>?>?
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.
final
name → Input<String?>?
The fully-qualified name of the CustomDomain.
final
ownershipState → Input<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 of foo.com also grants that project ownership over bar.foo.com, unless you add specific TXT records to bar.foo.com that grant a different project ownership. If your CustomDomain is in an OwnershipState other than OWNERSHIP_ACTIVE for more than 30 days and it hasn't been updated in at least 30 days, Hosting's ownership systems delete the CustomDomain. OWNERSHIP_MISSING: Your CustomDomain's domain name has no Hosting-related ownership records; no Firebase project has permission to act on the domain name's behalf. OWNERSHIP_UNREACHABLE: Your CustomDomain's domain name can't be reached. Hosting services' DNS queries to find your domain name's ownership records resulted in errors. See your CustomDomain's issues field for more details. OWNERSHIP_MISMATCH: Your CustomDomain's domain name is owned by another Firebase project. Remove the conflicting TXT records and replace them with project-specific records for your current Firebase project. OWNERSHIP_CONFLICT: Your CustomDomain's domain name has conflicting TXT 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: Your CustomDomain's DNS records are configured correctly. Hosting will transfer ownership of your domain to this CustomDomain within 24 hours. OWNERSHIP_ACTIVE: Your CustomDomain's domain name has TXT records that grant its project permission to act on its behalf.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
reconciling → Input<bool?>?
if true, indicates that Hosting's systems are attempting to make the CustomDomain's state match your preferred state. This is most frequently true when initially provisioning a CustomDomain or when creating a new SSL certificate to match an updated certPreference
final
redirectTarget → Input<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 redirectTarget instead.
final
requiredDnsUpdates → Input<List<HostingCustomDomainRequiredDnsUpdate>?>?
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.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
siteId → Input<String?>?
The ID of the site in which to create this custom domain association.
final
updateTime → Input<String?>?
The last time the CustomDomain was updated.
final
waitDnsVerification → Input<bool?>?
If true, Terraform will wait for DNS records to be fully resolved on the CustomDomain. If false, Terraform will not wait for DNS records on the CustomDomain. Any issues in the CustomDomain will be returned and stored in the Terraform state.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited