This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.
firebase¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.
- class
pulumi_gcp.firebase.AwaitableGetWebAppConfigResult(api_key=None, auth_domain=None, database_url=None, id=None, location_id=None, measurement_id=None, messaging_sender_id=None, project=None, storage_bucket=None, web_app_id=None)¶
- class
pulumi_gcp.firebase.AwaitableGetWebAppResult(app_id=None, display_name=None, id=None, name=None, project=None)¶
- class
pulumi_gcp.firebase.GetWebAppConfigResult(api_key=None, auth_domain=None, database_url=None, id=None, location_id=None, measurement_id=None, messaging_sender_id=None, project=None, storage_bucket=None, web_app_id=None)¶ A collection of values returned by getWebAppConfig.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_gcp.firebase.GetWebAppResult(app_id=None, display_name=None, id=None, name=None, project=None)¶ A collection of values returned by getWebApp.
id= None¶The provider-assigned unique ID for this managed resource.
- class
pulumi_gcp.firebase.Project(resource_name, opts=None, project=None, __props__=None, __name__=None, __opts__=None)¶ 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:
How-to Guides
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
display_name: pulumi.Output[str] = None¶The GCP project display name
project: pulumi.Output[str] = None¶The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
project_number: pulumi.Output[str] = None¶The number of the google project that firebase is enabled on.
- static
get(resource_name, id, opts=None, display_name=None, project=None, project_number=None)¶ Get an existing Project resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
display_name (pulumi.Input[str]) – The GCP project display name
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
project_number (pulumi.Input[str]) – The number of the google project that firebase is enabled on.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_gcp.firebase.ProjectLocation(resource_name, opts=None, location_id=None, project=None, __props__=None, __name__=None, __opts__=None)¶ Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.
This method creates an App Engine application with a default Cloud Storage bucket, located in the specified locationId. This location must be one of the available GCP resource locations.
After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified FirebaseProject might already be set because either the GCP Project already has an App Engine application or defaultLocation.finalize was previously called with a specified locationId. Any new calls to defaultLocation.finalize with a different specified locationId will return a 409 error.
To get more information about ProjectLocation, see:
How-to Guides
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
location_id (pulumi.Input[str]) – The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
location_id: pulumi.Output[str] = None¶The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.
project: pulumi.Output[str] = None¶The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- static
get(resource_name, id, opts=None, location_id=None, project=None)¶ Get an existing ProjectLocation resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
location_id (pulumi.Input[str]) – The ID of the default GCP resource location for the Project. The location must be one of the available GCP resource locations.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_gcp.firebase.WebApp(resource_name, opts=None, display_name=None, project=None, __props__=None, __name__=None, __opts__=None)¶ A Google Cloud Firebase web application instance
To get more information about WebApp, see:
How-to Guides
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
display_name (pulumi.Input[str]) – The user-assigned display name of the App.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
app_id: pulumi.Output[str] = None¶Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.
display_name: pulumi.Output[str] = None¶The user-assigned display name of the App.
name: pulumi.Output[str] = None¶The fully qualified resource name of the App, for example: projects/projectId/webApps/appId
project: pulumi.Output[str] = None¶The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- static
get(resource_name, id, opts=None, app_id=None, display_name=None, name=None, project=None)¶ Get an existing WebApp resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
app_id (pulumi.Input[str]) – Immutable. The globally unique, Firebase-assigned identifier of the App. This identifier should be treated as an opaque token, as the data format is not specified.
display_name (pulumi.Input[str]) – The user-assigned display name of the App.
name (pulumi.Input[str]) – The fully qualified resource name of the App, for example: projects/projectId/webApps/appId
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
translate_output_property(prop)¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop)¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
pulumi_gcp.firebase.get_web_app(app_id=None, opts=None)¶A Google Cloud Firebase web application instance
- Parameters
app_id (str) – The app_ip of name of the Firebase webApp.
pulumi_gcp.firebase.get_web_app_config(project=None, web_app_id=None, opts=None)¶A Google Cloud Firebase web application configuration
To get more information about WebApp, see:
How-to Guides
- Parameters
project (str) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
web_app_id (str) – the id of the firebase web app