Package-level declarations

Types

Link copied to clipboard
class AndroidApp : KotlinCustomResource
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>
Link copied to clipboard
Link copied to clipboard
object AndroidAppMapper : ResourceMapper<AndroidApp>
Link copied to clipboard
Link copied to clipboard
class AppCheckAppAttestConfig : KotlinCustomResource

An app's App Attest configuration object. Note that the Team ID registered with your app is used as part of the validation process. Make sure your gcp.firebase.AppleApp has a team_id present. To get more information about AppAttestConfig, see:

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

An app's App Attest configuration object. Note that the Team ID registered with your app is used as part of the validation process. Make sure your gcp.firebase.AppleApp has a team_id present. To get more information about AppAttestConfig, see:

Link copied to clipboard
Link copied to clipboard
class AppCheckDebugToken : KotlinCustomResource

A debug token is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. To get more information about DebugToken, see:

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

A debug token is a secret used during the development or integration testing of an app. It essentially allows the development or integration testing to bypass app attestation while still allowing App Check to enforce protection on supported production Firebase services. To get more information about DebugToken, see:

Link copied to clipboard
Link copied to clipboard
class AppCheckDeviceCheckConfig : KotlinCustomResource

An app's DeviceCheck configuration object. Note that the Team ID registered with your app is used as part of the validation process. Make sure your gcp.firebase.AppleApp has a team_id present. To get more information about DeviceCheckConfig, see:

Link copied to clipboard
data class AppCheckDeviceCheckConfigArgs(val appId: Output<String>? = null, val keyId: Output<String>? = null, val privateKey: Output<String>? = null, val project: Output<String>? = null, val tokenTtl: Output<String>? = null) : ConvertibleToJava<AppCheckDeviceCheckConfigArgs>

An app's DeviceCheck configuration object. Note that the Team ID registered with your app is used as part of the validation process. Make sure your gcp.firebase.AppleApp has a team_id present. To get more information about DeviceCheckConfig, see:

Link copied to clipboard
class AppCheckPlayIntegrityConfig : KotlinCustomResource

An app's Play Integrity configuration object. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API. Make sure your gcp.firebase.AndroidApp has at least one sha256_hashes present. To get more information about PlayIntegrityConfig, see:

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

An app's Play Integrity configuration object. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API. Make sure your gcp.firebase.AndroidApp has at least one sha256_hashes present. To get more information about PlayIntegrityConfig, see:

Link copied to clipboard
class AppCheckRecaptchaEnterpriseConfig : KotlinCustomResource

An app's reCAPTCHA Enterprise configuration object. To get more information about RecaptchaEnterpriseConfig, see:

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

An app's reCAPTCHA Enterprise configuration object. To get more information about RecaptchaEnterpriseConfig, see:

Link copied to clipboard
class AppCheckRecaptchaV3Config : KotlinCustomResource

An app's reCAPTCHA V3 configuration object. To get more information about RecaptchaV3Config, see:

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

An app's reCAPTCHA V3 configuration object. To get more information about RecaptchaV3Config, see:

Link copied to clipboard
class AppCheckServiceConfig : KotlinCustomResource

The enforcement configuration for a service supported by App Check. To get more information about ServiceConfig, see:

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

The enforcement configuration for a service supported by App Check. To get more information about ServiceConfig, see:

Link copied to clipboard
Link copied to clipboard
class AppleApp : KotlinCustomResource
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>
Link copied to clipboard
Link copied to clipboard
object AppleAppMapper : ResourceMapper<AppleApp>
Link copied to clipboard
Link copied to clipboard
class DatabaseInstance : KotlinCustomResource
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>
Link copied to clipboard
object DatabaseInstanceMapper : ResourceMapper<DatabaseInstance>
Link copied to clipboard
class ExtensionsInstance : KotlinCustomResource
Link copied to clipboard
data class ExtensionsInstanceArgs(val config: Output<ExtensionsInstanceConfigArgs>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<ExtensionsInstanceArgs>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
class HostingChannel : KotlinCustomResource
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>
Link copied to clipboard
Link copied to clipboard
object HostingChannelMapper : ResourceMapper<HostingChannel>
Link copied to clipboard
class HostingCustomDomain : KotlinCustomResource
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>
Link copied to clipboard
Link copied to clipboard
class HostingRelease : KotlinCustomResource
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>
Link copied to clipboard
Link copied to clipboard
object HostingReleaseMapper : ResourceMapper<HostingRelease>
Link copied to clipboard
class HostingSite : KotlinCustomResource
Link copied to clipboard
data class HostingSiteArgs(val appId: Output<String>? = null, val project: Output<String>? = null, val siteId: Output<String>? = null) : ConvertibleToJava<HostingSiteArgs>
Link copied to clipboard
Link copied to clipboard
object HostingSiteMapper : ResourceMapper<HostingSite>
Link copied to clipboard
Link copied to clipboard
class HostingVersion : KotlinCustomResource
Link copied to clipboard
data class HostingVersionArgs(val config: Output<HostingVersionConfigArgs>? = null, val siteId: Output<String>? = null) : ConvertibleToJava<HostingVersionArgs>
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
Link copied to clipboard
data class StorageBucketArgs(val bucketId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<StorageBucketArgs>
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