Documentation
¶
Index ¶
- type GetWebAppConfigArgs
- type GetWebAppConfigResult
- type LookupWebAppArgs
- type LookupWebAppResult
- type Project
- type ProjectArgs
- type ProjectInput
- type ProjectLocation
- type ProjectLocationArgs
- type ProjectLocationInput
- type ProjectLocationOutput
- type ProjectLocationState
- type ProjectOutput
- type ProjectState
- type WebApp
- type WebAppArgs
- type WebAppInput
- type WebAppOutput
- type WebAppState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetWebAppConfigArgs ¶
type GetWebAppConfigArgs struct { // The ID of the project in which the resource belongs. If it // is not provided, the provider project is used. Project *string `pulumi:"project"` // the id of the firebase web app WebAppId string `pulumi:"webAppId"` }
A collection of arguments for invoking getWebAppConfig.
type GetWebAppConfigResult ¶
type GetWebAppConfigResult struct { ApiKey string `pulumi:"apiKey"` AuthDomain string `pulumi:"authDomain"` DatabaseUrl string `pulumi:"databaseUrl"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` LocationId string `pulumi:"locationId"` MeasurementId string `pulumi:"measurementId"` MessagingSenderId string `pulumi:"messagingSenderId"` Project *string `pulumi:"project"` StorageBucket string `pulumi:"storageBucket"` WebAppId string `pulumi:"webAppId"` }
A collection of values returned by getWebAppConfig.
func GetWebAppConfig ¶
func GetWebAppConfig(ctx *pulumi.Context, args *GetWebAppConfigArgs, opts ...pulumi.InvokeOption) (*GetWebAppConfigResult, error)
A Google Cloud Firebase web application configuration
To get more information about WebApp, see:
* [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps) * How-to Guides
- [Official Documentation](https://firebase.google.com/)
type LookupWebAppArgs ¶
type LookupWebAppArgs struct { // The appIp of name of the Firebase webApp. AppId string `pulumi:"appId"` }
A collection of arguments for invoking getWebApp.
type LookupWebAppResult ¶
type LookupWebAppResult struct { AppId string `pulumi:"appId"` DisplayName string `pulumi:"displayName"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` Name string `pulumi:"name"` Project string `pulumi:"project"` }
A collection of values returned by getWebApp.
func LookupWebApp ¶
func LookupWebApp(ctx *pulumi.Context, args *LookupWebAppArgs, opts ...pulumi.InvokeOption) (*LookupWebAppResult, error)
A Google Cloud Firebase web application instance
type Project ¶
type Project struct { pulumi.CustomResourceState // The GCP project display name DisplayName pulumi.StringOutput `pulumi:"displayName"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` // The number of the google project that firebase is enabled on. ProjectNumber pulumi.StringOutput `pulumi:"projectNumber"` }
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:
* [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects) * How-to Guides
- [Official Documentation](https://firebase.google.com/)
## Example Usage
## Import
Project can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:firebase/project:Project default projects/{{project}}
```
```sh
$ pulumi import gcp:firebase/project:Project default {{project}}
```
func GetProject ¶
func GetProject(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ProjectState, opts ...pulumi.ResourceOption) (*Project, error)
GetProject gets an existing Project resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProject ¶
func NewProject(ctx *pulumi.Context, name string, args *ProjectArgs, opts ...pulumi.ResourceOption) (*Project, error)
NewProject registers a new resource with the given unique name, arguments, and options.
func (Project) ElementType ¶ added in v4.4.0
func (Project) ToProjectOutput ¶ added in v4.4.0
func (i Project) ToProjectOutput() ProjectOutput
func (Project) ToProjectOutputWithContext ¶ added in v4.4.0
func (i Project) ToProjectOutputWithContext(ctx context.Context) ProjectOutput
type ProjectArgs ¶
type ProjectArgs struct { // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
The set of arguments for constructing a Project resource.
func (ProjectArgs) ElementType ¶
func (ProjectArgs) ElementType() reflect.Type
type ProjectInput ¶ added in v4.4.0
type ProjectInput interface { pulumi.Input ToProjectOutput() ProjectOutput ToProjectOutputWithContext(ctx context.Context) ProjectOutput }
type ProjectLocation ¶
type ProjectLocation struct { pulumi.CustomResourceState // The ID of the default GCP resource location for the Project. The location must be one of the available GCP // resource locations. LocationId pulumi.StringOutput `pulumi:"locationId"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` }
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:
* [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.defaultLocation/finalize) * How-to Guides
- [Official Documentation](https://firebase.google.com/)
## Example Usage
## Import
ProjectLocation can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:firebase/projectLocation:ProjectLocation default projects/{{project}}
```
```sh
$ pulumi import gcp:firebase/projectLocation:ProjectLocation default {{project}}
```
func GetProjectLocation ¶
func GetProjectLocation(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ProjectLocationState, opts ...pulumi.ResourceOption) (*ProjectLocation, error)
GetProjectLocation gets an existing ProjectLocation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProjectLocation ¶
func NewProjectLocation(ctx *pulumi.Context, name string, args *ProjectLocationArgs, opts ...pulumi.ResourceOption) (*ProjectLocation, error)
NewProjectLocation registers a new resource with the given unique name, arguments, and options.
func (ProjectLocation) ElementType ¶ added in v4.4.0
func (ProjectLocation) ElementType() reflect.Type
func (ProjectLocation) ToProjectLocationOutput ¶ added in v4.4.0
func (i ProjectLocation) ToProjectLocationOutput() ProjectLocationOutput
func (ProjectLocation) ToProjectLocationOutputWithContext ¶ added in v4.4.0
func (i ProjectLocation) ToProjectLocationOutputWithContext(ctx context.Context) ProjectLocationOutput
type ProjectLocationArgs ¶
type ProjectLocationArgs struct { // The ID of the default GCP resource location for the Project. The location must be one of the available GCP // resource locations. LocationId pulumi.StringInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
The set of arguments for constructing a ProjectLocation resource.
func (ProjectLocationArgs) ElementType ¶
func (ProjectLocationArgs) ElementType() reflect.Type
type ProjectLocationInput ¶ added in v4.4.0
type ProjectLocationInput interface { pulumi.Input ToProjectLocationOutput() ProjectLocationOutput ToProjectLocationOutputWithContext(ctx context.Context) ProjectLocationOutput }
type ProjectLocationOutput ¶ added in v4.4.0
type ProjectLocationOutput struct {
*pulumi.OutputState
}
func (ProjectLocationOutput) ElementType ¶ added in v4.4.0
func (ProjectLocationOutput) ElementType() reflect.Type
func (ProjectLocationOutput) ToProjectLocationOutput ¶ added in v4.4.0
func (o ProjectLocationOutput) ToProjectLocationOutput() ProjectLocationOutput
func (ProjectLocationOutput) ToProjectLocationOutputWithContext ¶ added in v4.4.0
func (o ProjectLocationOutput) ToProjectLocationOutputWithContext(ctx context.Context) ProjectLocationOutput
type ProjectLocationState ¶
type ProjectLocationState struct { // The ID of the default GCP resource location for the Project. The location must be one of the available GCP // resource locations. LocationId pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
func (ProjectLocationState) ElementType ¶
func (ProjectLocationState) ElementType() reflect.Type
type ProjectOutput ¶ added in v4.4.0
type ProjectOutput struct {
*pulumi.OutputState
}
func (ProjectOutput) ElementType ¶ added in v4.4.0
func (ProjectOutput) ElementType() reflect.Type
func (ProjectOutput) ToProjectOutput ¶ added in v4.4.0
func (o ProjectOutput) ToProjectOutput() ProjectOutput
func (ProjectOutput) ToProjectOutputWithContext ¶ added in v4.4.0
func (o ProjectOutput) ToProjectOutputWithContext(ctx context.Context) ProjectOutput
type ProjectState ¶
type ProjectState struct { // The GCP project display name DisplayName pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput // The number of the google project that firebase is enabled on. ProjectNumber pulumi.StringPtrInput }
func (ProjectState) ElementType ¶
func (ProjectState) ElementType() reflect.Type
type WebApp ¶
type WebApp struct { pulumi.CustomResourceState // 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. AppId pulumi.StringOutput `pulumi:"appId"` // The user-assigned display name of the App. DisplayName pulumi.StringOutput `pulumi:"displayName"` // The fully qualified resource name of the App, for example: projects/projectId/webApps/appId Name pulumi.StringOutput `pulumi:"name"` // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringOutput `pulumi:"project"` }
A Google Cloud Firebase web application instance
To get more information about WebApp, see:
* [API documentation](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.webApps) * How-to Guides
- [Official Documentation](https://firebase.google.com/)
## Example Usage
## Import
WebApp can be imported using any of these accepted formats ¶
```sh
$ pulumi import gcp:firebase/webApp:WebApp default {{name}}
```
func GetWebApp ¶
func GetWebApp(ctx *pulumi.Context, name string, id pulumi.IDInput, state *WebAppState, opts ...pulumi.ResourceOption) (*WebApp, error)
GetWebApp gets an existing WebApp resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewWebApp ¶
func NewWebApp(ctx *pulumi.Context, name string, args *WebAppArgs, opts ...pulumi.ResourceOption) (*WebApp, error)
NewWebApp registers a new resource with the given unique name, arguments, and options.
func (WebApp) ElementType ¶ added in v4.4.0
func (WebApp) ToWebAppOutput ¶ added in v4.4.0
func (i WebApp) ToWebAppOutput() WebAppOutput
func (WebApp) ToWebAppOutputWithContext ¶ added in v4.4.0
func (i WebApp) ToWebAppOutputWithContext(ctx context.Context) WebAppOutput
type WebAppArgs ¶
type WebAppArgs struct { // The user-assigned display name of the App. DisplayName pulumi.StringInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
The set of arguments for constructing a WebApp resource.
func (WebAppArgs) ElementType ¶
func (WebAppArgs) ElementType() reflect.Type
type WebAppInput ¶ added in v4.4.0
type WebAppInput interface { pulumi.Input ToWebAppOutput() WebAppOutput ToWebAppOutputWithContext(ctx context.Context) WebAppOutput }
type WebAppOutput ¶ added in v4.4.0
type WebAppOutput struct {
*pulumi.OutputState
}
func (WebAppOutput) ElementType ¶ added in v4.4.0
func (WebAppOutput) ElementType() reflect.Type
func (WebAppOutput) ToWebAppOutput ¶ added in v4.4.0
func (o WebAppOutput) ToWebAppOutput() WebAppOutput
func (WebAppOutput) ToWebAppOutputWithContext ¶ added in v4.4.0
func (o WebAppOutput) ToWebAppOutputWithContext(ctx context.Context) WebAppOutput
type WebAppState ¶
type WebAppState struct { // 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. AppId pulumi.StringPtrInput // The user-assigned display name of the App. DisplayName pulumi.StringPtrInput // The fully qualified resource name of the App, for example: projects/projectId/webApps/appId Name pulumi.StringPtrInput // The ID of the project in which the resource belongs. // If it is not provided, the provider project is used. Project pulumi.StringPtrInput }
func (WebAppState) ElementType ¶
func (WebAppState) ElementType() reflect.Type