Package-level declarations

Types

Link copied to clipboard
class AndroidApp : KotlinCustomResource

AndroidApp can be imported using any of these accepted formats* {{project}} projects/{{project}}/androidApps/{{app_id}} * projects/{{project}}/androidApps/{{app_id}} * {{project}}/{{project}}/{{app_id}} * androidApps/{{app_id}} * {{app_id}} In Terraform v1.5.0 and later, use an import block to import AndroidApp using one of the formats above. For exampletf import { id = "{{project}} projects/{{project}}/androidApps/{{app_id}}" to = google_firebase_android_app.default }

Link copied to clipboard
data class AndroidAppArgs(val apiKeyId: Output<String>? = null, val deletionPolicy: Output<String>? = null, val displayName: Output<String>? = null, val packageName: Output<String>? = null, val project: Output<String>? = null, val sha1Hashes: Output<List<String>>? = null, val sha256Hashes: Output<List<String>>? = null) : ConvertibleToJava<AndroidAppArgs>

AndroidApp can be imported using any of these accepted formats* {{project}} projects/{{project}}/androidApps/{{app_id}} * projects/{{project}}/androidApps/{{app_id}} * {{project}}/{{project}}/{{app_id}} * androidApps/{{app_id}} * {{app_id}} In Terraform v1.5.0 and later, use an import block to import AndroidApp using one of the formats above. For exampletf import { id = "{{project}} projects/{{project}}/androidApps/{{app_id}}" to = google_firebase_android_app.default }

Link copied to clipboard
Link copied to clipboard
object AndroidAppMapper : ResourceMapper<AndroidApp>
Link copied to clipboard
Link copied to clipboard
class AppleApp : KotlinCustomResource

AppleApp can be imported using any of these accepted formats* {{project}} projects/{{project}}/iosApps/{{app_id}} * projects/{{project}}/iosApps/{{app_id}} * {{project}}/{{project}}/{{app_id}} * iosApps/{{app_id}} * {{app_id}} In Terraform v1.5.0 and later, use an import block to import AppleApp using one of the formats above. For exampletf import { id = "{{project}} projects/{{project}}/iosApps/{{app_id}}" to = google_firebase_apple_app.default }

Link copied to clipboard
data class AppleAppArgs(val apiKeyId: Output<String>? = null, val appStoreId: Output<String>? = null, val bundleId: Output<String>? = null, val deletionPolicy: Output<String>? = null, val displayName: Output<String>? = null, val project: Output<String>? = null, val teamId: Output<String>? = null) : ConvertibleToJava<AppleAppArgs>

AppleApp can be imported using any of these accepted formats* {{project}} projects/{{project}}/iosApps/{{app_id}} * projects/{{project}}/iosApps/{{app_id}} * {{project}}/{{project}}/{{app_id}} * iosApps/{{app_id}} * {{app_id}} In Terraform v1.5.0 and later, use an import block to import AppleApp using one of the formats above. For exampletf import { id = "{{project}} projects/{{project}}/iosApps/{{app_id}}" to = google_firebase_apple_app.default }

Link copied to clipboard
Link copied to clipboard
object AppleAppMapper : ResourceMapper<AppleApp>
Link copied to clipboard
Link copied to clipboard
class DatabaseInstance : KotlinCustomResource

Instance can be imported using any of these accepted formats* projects/{{project}}/locations/{{region}}/instances/{{instance_id}} * {{project}}/{{region}}/{{instance_id}} * {{region}}/{{instance_id}} * {{instance_id}} In Terraform v1.5.0 and later, use an import block to import Instance using one of the formats above. For exampletf import { id = "projects/{{project}}/locations/{{region}}/instances/{{instance_id}}" to = google_firebase_database_instance.default }

Link copied to clipboard
data class DatabaseInstanceArgs(val desiredState: Output<String>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null, val region: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<DatabaseInstanceArgs>

Instance can be imported using any of these accepted formats* projects/{{project}}/locations/{{region}}/instances/{{instance_id}} * {{project}}/{{region}}/{{instance_id}} * {{region}}/{{instance_id}} * {{instance_id}} In Terraform v1.5.0 and later, use an import block to import Instance using one of the formats above. For exampletf import { id = "projects/{{project}}/locations/{{region}}/instances/{{instance_id}}" to = google_firebase_database_instance.default }

Link copied to clipboard
object DatabaseInstanceMapper : ResourceMapper<DatabaseInstance>
Link copied to clipboard
class ExtensionsInstance : KotlinCustomResource

Instance can be imported using any of these accepted formats* projects/{{project}}/instances/{{instance_id}} * {{project}}/{{instance_id}} * {{instance_id}} In Terraform v1.5.0 and later, use an import block to import Instance using one of the formats above. For exampletf import { id = "projects/{{project}}/instances/{{instance_id}}" to = google_firebase_extensions_instance.default }

Link copied to clipboard
data class ExtensionsInstanceArgs(val config: Output<ExtensionsInstanceConfigArgs>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ExtensionsInstanceArgs>

Instance can be imported using any of these accepted formats* projects/{{project}}/instances/{{instance_id}} * {{project}}/{{instance_id}} * {{instance_id}} In Terraform v1.5.0 and later, use an import block to import Instance using one of the formats above. For exampletf import { id = "projects/{{project}}/instances/{{instance_id}}" to = google_firebase_extensions_instance.default }

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class HostingChannel : KotlinCustomResource

Channel can be imported using any of these accepted formats* sites/{{site_id}}/channels/{{channel_id}} * {{site_id}}/{{channel_id}} In Terraform v1.5.0 and later, use an import block to import Channel using one of the formats above. For exampletf import { id = "sites/{{site_id}}/channels/{{channel_id}}" to = google_firebase_hosting_channel.default }

Link copied to clipboard
data class HostingChannelArgs(val channelId: Output<String>? = null, val expireTime: Output<String>? = null, val labels: Output<Map<String, String>>? = null, val retainedReleaseCount: Output<Int>? = null, val siteId: Output<String>? = null, val ttl: Output<String>? = null) : ConvertibleToJava<HostingChannelArgs>

Channel can be imported using any of these accepted formats* sites/{{site_id}}/channels/{{channel_id}} * {{site_id}}/{{channel_id}} In Terraform v1.5.0 and later, use an import block to import Channel using one of the formats above. For exampletf import { id = "sites/{{site_id}}/channels/{{channel_id}}" to = google_firebase_hosting_channel.default }

Link copied to clipboard
Link copied to clipboard
object HostingChannelMapper : ResourceMapper<HostingChannel>
Link copied to clipboard
class HostingCustomDomain : KotlinCustomResource

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}} In Terraform v1.5.0 and later, use an import block to import CustomDomain using one of the formats above. For exampletf import { id = "projects/{{project}}/sites/{{site_id}}/customDomains/{{custom_domain}}" to = google_firebase_hosting_custom_domain.default }

Link copied to clipboard
data class HostingCustomDomainArgs(val certPreference: Output<String>? = null, val customDomain: Output<String>? = null, val project: Output<String>? = null, val redirectTarget: Output<String>? = null, val siteId: Output<String>? = null, val waitDnsVerification: Output<Boolean>? = null) : ConvertibleToJava<HostingCustomDomainArgs>

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}} In Terraform v1.5.0 and later, use an import block to import CustomDomain using one of the formats above. For exampletf import { id = "projects/{{project}}/sites/{{site_id}}/customDomains/{{custom_domain}}" to = google_firebase_hosting_custom_domain.default }

Link copied to clipboard
Link copied to clipboard
class HostingRelease : KotlinCustomResource

Release can be imported using any of these accepted formats* sites/{{site_id}}/channels/{{channel_id}}/releases/{{release_id}} * sites/{{site_id}}/releases/{{release_id}} * {{site_id}}/{{channel_id}}/{{release_id}} * {{site_id}}/{{release_id}} In Terraform v1.5.0 and later, use an import block to import Release using one of the formats above. For exampletf import { id = "sites/{{site_id}}/channels/{{channel_id}}/releases/{{release_id}}" to = google_firebase_hosting_release.default }

Link copied to clipboard
data class HostingReleaseArgs(val channelId: Output<String>? = null, val message: Output<String>? = null, val siteId: Output<String>? = null, val type: Output<String>? = null, val versionName: Output<String>? = null) : ConvertibleToJava<HostingReleaseArgs>

Release can be imported using any of these accepted formats* sites/{{site_id}}/channels/{{channel_id}}/releases/{{release_id}} * sites/{{site_id}}/releases/{{release_id}} * {{site_id}}/{{channel_id}}/{{release_id}} * {{site_id}}/{{release_id}} In Terraform v1.5.0 and later, use an import block to import Release using one of the formats above. For exampletf import { id = "sites/{{site_id}}/channels/{{channel_id}}/releases/{{release_id}}" to = google_firebase_hosting_release.default }

Link copied to clipboard
Link copied to clipboard
object HostingReleaseMapper : ResourceMapper<HostingRelease>
Link copied to clipboard
class HostingSite : KotlinCustomResource

Site can be imported using any of these accepted formats* projects/{{project}}/sites/{{site_id}} * {{project}}/{{site_id}} * sites/{{site_id}} * {{site_id}} In Terraform v1.5.0 and later, use an import block to import Site using one of the formats above. For exampletf import { id = "projects/{{project}}/sites/{{site_id}}" to = google_firebase_hosting_site.default }

Link copied to clipboard
data class HostingSiteArgs(val appId: Output<String>? = null, val project: Output<String>? = null, val siteId: Output<String>? = null) : ConvertibleToJava<HostingSiteArgs>

Site can be imported using any of these accepted formats* projects/{{project}}/sites/{{site_id}} * {{project}}/{{site_id}} * sites/{{site_id}} * {{site_id}} In Terraform v1.5.0 and later, use an import block to import Site using one of the formats above. For exampletf import { id = "projects/{{project}}/sites/{{site_id}}" to = google_firebase_hosting_site.default }

Link copied to clipboard
Link copied to clipboard
object HostingSiteMapper : ResourceMapper<HostingSite>
Link copied to clipboard
Link copied to clipboard
class HostingVersion : KotlinCustomResource

Version can be imported using any of these accepted formats* sites/{{site_id}}/versions/{{version_id}} * {{site_id}}/{{version_id}} In Terraform v1.5.0 and later, use an import block to import Version using one of the formats above. For exampletf import { id = "sites/{{site_id}}/versions/{{version_id}}" to = google_firebase_hosting_version.default }

Link copied to clipboard
data class HostingVersionArgs(val config: Output<HostingVersionConfigArgs>? = null, val siteId: Output<String>? = null) : ConvertibleToJava<HostingVersionArgs>

Version can be imported using any of these accepted formats* sites/{{site_id}}/versions/{{version_id}} * {{site_id}}/{{version_id}} In Terraform v1.5.0 and later, use an import block to import Version using one of the formats above. For exampletf import { id = "sites/{{site_id}}/versions/{{version_id}}" to = google_firebase_hosting_version.default }

Link copied to clipboard
Link copied to clipboard
object HostingVersionMapper : ResourceMapper<HostingVersion>
Link copied to clipboard
class Project : KotlinCustomResource

A Google Cloud Firebase instance. This enables Firebase resources on a given google project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject uses underlying GCP identifiers (most importantly, the projectId) as its own for easy interop with GCP APIs. Once Firebase has been added to a Google Project it cannot be removed. To get more information about Project, see:

Link copied to clipboard
data class ProjectArgs(val project: Output<String>? = null) : ConvertibleToJava<ProjectArgs>

A Google Cloud Firebase instance. This enables Firebase resources on a given google project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject uses underlying GCP identifiers (most importantly, the projectId) as its own for easy interop with GCP APIs. Once Firebase has been added to a Google Project it cannot be removed. To get more information about Project, see:

Link copied to clipboard
Link copied to clipboard
object ProjectMapper : ResourceMapper<Project>
Link copied to clipboard
Link copied to clipboard
class StorageBucket : KotlinCustomResource

Bucket can be imported using any of these accepted formats* projects/{{project}}/buckets/{{bucket_id}} * {{project}}/{{bucket_id}} * {{bucket_id}} In Terraform v1.5.0 and later, use an import block to import Bucket using one of the formats above. For exampletf import { id = "projects/{{project}}/buckets/{{bucket_id}}" to = google_firebase_storage_bucket.default }

Link copied to clipboard
data class StorageBucketArgs(val bucketId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<StorageBucketArgs>

Bucket can be imported using any of these accepted formats* projects/{{project}}/buckets/{{bucket_id}} * {{project}}/{{bucket_id}} * {{bucket_id}} In Terraform v1.5.0 and later, use an import block to import Bucket using one of the formats above. For exampletf import { id = "projects/{{project}}/buckets/{{bucket_id}}" to = google_firebase_storage_bucket.default }

Link copied to clipboard
Link copied to clipboard
object StorageBucketMapper : ResourceMapper<StorageBucket>
Link copied to clipboard
Link copied to clipboard
class WebApp : KotlinCustomResource

A Google Cloud Firebase web application instance To get more information about WebApp, see:

Link copied to clipboard
data class WebAppArgs(val apiKeyId: Output<String>? = null, val deletionPolicy: Output<String>? = null, val displayName: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<WebAppArgs>

A Google Cloud Firebase web application instance To get more information about WebApp, see:

Link copied to clipboard

Builder for WebAppArgs.

Link copied to clipboard
object WebAppMapper : ResourceMapper<WebApp>
Link copied to clipboard

Builder for WebApp.

Functions

Link copied to clipboard
suspend fun androidApp(name: String, block: suspend AndroidAppResourceBuilder.() -> Unit): AndroidApp
Link copied to clipboard
suspend fun appleApp(name: String, block: suspend AppleAppResourceBuilder.() -> Unit): AppleApp
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
suspend fun hostingSite(name: String, block: suspend HostingSiteResourceBuilder.() -> Unit): HostingSite
Link copied to clipboard
Link copied to clipboard
fun project(name: String): Project
suspend fun project(name: String, block: suspend ProjectResourceBuilder.() -> Unit): Project
Link copied to clipboard
Link copied to clipboard
fun webApp(name: String): WebApp
suspend fun webApp(name: String, block: suspend WebAppResourceBuilder.() -> Unit): WebApp