firebasehosting library

Classes

ActingUserResponse
Contains metadata about the user who performed an action, such as creating a release or finalizing a version.
CertDnsChallengeResponse
Represents a DNS certificate challenge.
CertHttpChallengeResponse
Represents an HTTP certificate challenge.
CertificateResponse
An SSL certificate used to provide end-to-end encryption for requests against your domain name. A Certificate can be an actual SSL certificate or, for newly-created custom domains, Hosting's intent to create one.
CertVerificationResponse
A set of ACME challenges you can use to allow Hosting to create an SSL certificate for your domain name before directing traffic to Hosting servers. Use either the DNS or HTTP challenge; it's not necessary to provide both.
Channel
Creates a new channel in the specified site.
ChannelArgs
The set of arguments for Channel. The set of arguments for Channel.
CloudRunRewrite
A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a 404 error).
CloudRunRewriteResponse
A configured rewrite that directs requests to a Cloud Run service. If the Cloud Run service does not exist when setting or updating your Firebase Hosting configuration, then the request fails. Any errors from the Cloud Run service are passed to the end user (for example, if you delete a service, any requests directed to that service receive a 404 error).
CustomDomain
Creates a CustomDomain. Auto-naming is currently not supported for this resource.
CustomDomainArgs
The set of arguments for CustomDomain. The set of arguments for CustomDomain.
DnsRecordResponse
DNS records are resource records that define how systems and services should behave when handling requests for a domain name. For example, when you add A records to your domain name's DNS records, you're informing other systems (such as your users' web browsers) to contact those IPv4 addresses to retrieve resources relevant to your domain name (such as your Hosting site files).
DnsRecordSetResponse
A set of DNS records relevant to the setup and maintenance of a custom domain in Firebase Hosting.
DnsUpdatesResponse
A set of DNS record updates that you should make to allow Hosting to serve secure content in response to requests against your domain name. These updates present the current state of your domain name's DNS records when Hosting last queried them, and the desired set of records that Hosting needs to see before your custom domain can be fully active.
Domain
Creates a domain mapping on the specified site. Auto-naming is currently not supported for this resource.
DomainArgs
The set of arguments for Domain. The set of arguments for Domain.
DomainProvisioningResponse
The current certificate provisioning status information for a domain.
DomainRedirect
Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.
DomainRedirectResponse
Defines the behavior of a domain-level redirect. Domain redirects preserve the path of the redirect but replace the requested domain with the one specified in the redirect configuration.
GetChannelArgs
Arguments for getChannel. Arguments for getChannel.
GetChannelResult
Result data returned by getChannel.
GetCustomDomainArgs
Arguments for getCustomDomain. Arguments for getCustomDomain.
GetCustomDomainResult
Result data returned by getCustomDomain.
GetDomainArgs
Arguments for getDomain. Arguments for getDomain.
GetDomainResult
Result data returned by getDomain.
GetReleaseArgs
Arguments for getRelease. Arguments for getRelease.
GetReleaseResult
Result data returned by getRelease.
GetSiteArgs
Arguments for getSite. Arguments for getSite.
GetSiteResult
Result data returned by getSite.
GetVersionArgs
Arguments for getVersion. Arguments for getVersion.
GetVersionResult
Result data returned by getVersion.
A Header specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
HeaderResponse
A Header specifies a URL pattern that, if matched to the request URL path, triggers Hosting to apply the specified custom response headers.
HttpUpdateResponse
A file you can add to your existing, non-Hosting hosting service that confirms your intent to allow Hosting's Certificate Authorities to create an SSL certificate for your domain.
I18nConfig
If provided, i18n rewrites are enabled.
I18nConfigResponse
If provided, i18n rewrites are enabled.
Redirect
A Redirect specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
RedirectResponse
A Redirect specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond with a redirect to the specified destination path.
Release
Creates a new release, which makes the content of the specified version actively display on the appropriate URL(s). Auto-naming is currently not supported for this resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ReleaseArgs
The set of arguments for Release. The set of arguments for Release.
ReleaseResponse
A Release is a particular collection of configurations and files that is set to be public at a particular time.
Rewrite
A Rewrite specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
RewriteResponse
A Rewrite specifies a URL pattern that, if matched to the request URL path, triggers Hosting to respond as if the service were given the specified destination URL.
ServingConfig
The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific priority order.
ServingConfigResponse
The configuration for how incoming requests to a site should be routed and processed before serving content. The URL request paths are matched against the specified URL patterns in the configuration, then Hosting applies the applicable configuration according to a specific priority order.
Site
Creates a new Hosting Site in the specified parent Firebase project. Note that Hosting sites can take several minutes to propagate through Firebase systems. Auto-naming is currently not supported for this resource.
SiteArgs
The set of arguments for Site. The set of arguments for Site.
StatusResponse
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Version
Creates a new version for the specified site.
VersionArgs
The set of arguments for Version. The set of arguments for Version.
VersionResponse
A Version is a configuration and a collection of static files which determine how a site is displayed.

Enums

CustomDomainCertPreference
A field that lets you specify which SSL certificate type Hosting creates for your domain name. Spark plan custom domains only have access to the GROUPED cert type, while Blaze plan domains can select any option.
DomainRedirectType
Required. The redirect status code.
ReleaseType
Explains the reason for the release. Specify a value for this field only when creating a SITE_DISABLE type release.
ServingConfigAppAssociation
How to handle well known App Association files.
ServingConfigTrailingSlashBehavior
Defines how to handle a trailing slash in the URL path.
VersionStatus
The deploy status of the version. For a successful deploy, call CreateVersion to make a new version (CREATED status), upload all desired files to the version, then update the version to the FINALIZED status. Note that if you leave the version in the CREATED state for more than 12 hours, the system will automatically mark the version as ABANDONED. You can also change the status of a version to DELETED by calling DeleteVersion.

Functions

getChannel(GetChannelArgs args, {InvokeOptions? options}) → Future<GetChannelResult>
Retrieves information for the specified channel of the specified site. args Arguments passed to this invoke. Arguments for getChannel. options Invoke options controlling this call.
getCustomDomain(GetCustomDomainArgs args, {InvokeOptions? options}) → Future<GetCustomDomainResult>
Gets the specified CustomDomain. args Arguments passed to this invoke. Arguments for getCustomDomain. options Invoke options controlling this call.
getDomain(GetDomainArgs args, {InvokeOptions? options}) → Future<GetDomainResult>
Gets a domain mapping on the specified site. args Arguments passed to this invoke. Arguments for getDomain. options Invoke options controlling this call.
getRelease(GetReleaseArgs args, {InvokeOptions? options}) → Future<GetReleaseResult>
Gets the specified release for a site or channel. When used to get a release for a site, this can get releases for both the default live channel and any active preview channels for the specified site. args Arguments passed to this invoke. Arguments for getRelease. options Invoke options controlling this call.
getSite(GetSiteArgs args, {InvokeOptions? options}) → Future<GetSiteResult>
Gets the specified Hosting Site. args Arguments passed to this invoke. Arguments for getSite. options Invoke options controlling this call.
getVersion(GetVersionArgs args, {InvokeOptions? options}) → Future<GetVersionResult>
Get the specified version that has been created for the specified site. This can include versions that were created for the default live channel or for any active preview channels for the specified site. args Arguments passed to this invoke. Arguments for getVersion. options Invoke options controlling this call.