Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. firebase
  5. firebase/v1beta1
  6. WebApp

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.firebase/v1beta1.WebApp

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Requests the creation of a new WebApp in the specified FirebaseProject. The result of this call is an Operation which can be used to track the provisioning process. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation. 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.

    Create WebApp Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new WebApp(name: string, args?: WebAppArgs, opts?: CustomResourceOptions);
    @overload
def WebApp(resource_name: str,
           args: Optional[WebAppArgs] = None,
           opts: Optional[ResourceOptions] = None)

@overload
def WebApp(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           api_key_id: Optional[str] = None,
           app_urls: Optional[Sequence[str]] = None,
           display_name: Optional[str] = None,
           etag: Optional[str] = None,
           name: Optional[str] = None,
           project: Optional[str] = None)
    func NewWebApp(ctx *Context, name string, args *WebAppArgs, opts ...ResourceOption) (*WebApp, error)
    public WebApp(string name, WebAppArgs? args = null, CustomResourceOptions? opts = null)
    public WebApp(String name, WebAppArgs args)
public WebApp(String name, WebAppArgs args, CustomResourceOptions options)

    type: google-native:firebase/v1beta1:WebApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebAppArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var webAppResource = new GoogleNative.Firebase.V1Beta1.WebApp("webAppResource", new()
{
    ApiKeyId = "string",
    AppUrls = new[]
    {
        "string",
    },
    DisplayName = "string",
    Etag = "string",
    Name = "string",
    Project = "string",
});

    example, err := firebase.NewWebApp(ctx, "webAppResource", &firebase.WebAppArgs{
ApiKeyId: pulumi.String("string"),
AppUrls: pulumi.StringArray{
pulumi.String("string"),
},
DisplayName: pulumi.String("string"),
Etag: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
})

    var webAppResource = new WebApp("webAppResource", WebAppArgs.builder()
    .apiKeyId("string")
    .appUrls("string")
    .displayName("string")
    .etag("string")
    .name("string")
    .project("string")
    .build());

    web_app_resource = google_native.firebase.v1beta1.WebApp("webAppResource",
    api_key_id="string",
    app_urls=["string"],
    display_name="string",
    etag="string",
    name="string",
    project="string")

    const webAppResource = new google_native.firebase.v1beta1.WebApp("webAppResource", {
    apiKeyId: "string",
    appUrls: ["string"],
    displayName: "string",
    etag: "string",
    name: "string",
    project: "string",
});

    type: google-native:firebase/v1beta1:WebApp
properties:
    apiKeyId: string
    appUrls:
        - string
    displayName: string
    etag: string
    name: string
    project: string

    WebApp Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The WebApp resource accepts the following input properties:

    ApiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    AppUrls List<string>
    The URLs where the WebApp is hosted.
    DisplayName string
    The user-assigned display name for the WebApp.
    Etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    Name string
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    Project string
    ApiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    AppUrls []string
    The URLs where the WebApp is hosted.
    DisplayName string
    The user-assigned display name for the WebApp.
    Etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    Name string
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    Project string
    apiKeyId String
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    appUrls List<String>
    The URLs where the WebApp is hosted.
    displayName String
    The user-assigned display name for the WebApp.
    etag String
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name String
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project String
    apiKeyId string
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    appUrls string[]
    The URLs where the WebApp is hosted.
    displayName string
    The user-assigned display name for the WebApp.
    etag string
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name string
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project string
    api_key_id str
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    app_urls Sequence[str]
    The URLs where the WebApp is hosted.
    display_name str
    The user-assigned display name for the WebApp.
    etag str
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name str
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project str
    apiKeyId String
    The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the WebApp. Be aware that this value is the UID of the API key, not the keyString of the API key. The keyString is the value that can be found in the App's configuration artifact. If api_key_id is not set in requests to webApps.Create, then Firebase automatically associates an api_key_id with the WebApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned. In patch requests, api_key_id cannot be set to an empty value, and the new UID must have no restrictions or only have restrictions that are valid for the associated WebApp. We recommend using the Google Cloud Console to manage API keys.
    appUrls List<String>
    The URLs where the WebApp is hosted.
    displayName String
    The user-assigned display name for the WebApp.
    etag String
    This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated.
    name String
    The resource name of the WebApp, in the format: projects/PROJECT_IDENTIFIER /webApps/APP_ID * PROJECT_IDENTIFIER: the parent Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. * APP_ID: the globally unique, Firebase-assigned identifier for the App (see appId).
    project String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WebApp resource produces the following output properties:

    AppId string
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    ExpireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The lifecycle state of the App.
    WebId string
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
    AppId string
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    ExpireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The lifecycle state of the App.
    WebId string
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
    appId String
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime String
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The lifecycle state of the App.
    webId String
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
    appId string
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime string
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id string
    The provider-assigned unique ID for this managed resource.
    state string
    The lifecycle state of the App.
    webId string
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
    app_id str
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expire_time str
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id str
    The provider-assigned unique ID for this managed resource.
    state str
    The lifecycle state of the App.
    web_id str
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.
    appId String
    Immutable. The globally unique, Firebase-assigned identifier for the WebApp. This identifier should be treated as an opaque token, as the data format is not specified.
    expireTime String
    Timestamp of when the App will be considered expired and cannot be undeleted. This value is only provided if the App is in the DELETED state.
    id String
    The provider-assigned unique ID for this managed resource.
    state String
    The lifecycle state of the App.
    webId String
    Immutable. A unique, Firebase-assigned identifier for the WebApp. This identifier is only used to populate the namespace value for the WebApp. For most use cases, use appId to identify or reference the App. The webId value is only unique within a FirebaseProject and its associated Apps.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native