AndroidApp class

A Google Cloud Firebase Android application instance

> Warning: This resource is in beta, and should be used with the terraform-provider-google-beta provider. See Provider Versions for more details on beta resources.

To get more information about AndroidApp, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebase Android App Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const basic = new gcp.firebase.AndroidApp("basic", {
    project: "my-project-name",
    displayName: "Display Name Basic",
    packageName: "android.package.app",
    sha1Hashes: ["2145bdf698b8715039bd0e83f2069bed435ac21c"],
    sha256Hashes: ["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"],
});

import pulumi
import pulumi_gcp as gcp

basic = gcp.firebase.AndroidApp("basic",
    project="my-project-name",
    display_name="Display Name Basic",
    package_name="android.package.app",
    sha1_hashes=["2145bdf698b8715039bd0e83f2069bed435ac21c"],
    sha256_hashes=["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.Firebase.AndroidApp("basic", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name Basic",
        PackageName = "android.package.app",
        Sha1Hashes = new[]
        {
            "2145bdf698b8715039bd0e83f2069bed435ac21c",
        },
        Sha256Hashes = new[]
        {
            "2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc",
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := firebase.NewAndroidApp(ctx, "basic", &firebase.AndroidAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Display Name Basic"),
			PackageName: pulumi.String("android.package.app"),
			Sha1Hashes: pulumi.StringArray{
				pulumi.String("2145bdf698b8715039bd0e83f2069bed435ac21c"),
			},
			Sha256Hashes: pulumi.StringArray{
				pulumi.String("2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firebase_androidapp" "basic" {
  project       = "my-project-name"
  display_name  = "Display Name Basic"
  package_name  = "android.package.app"
  sha1_hashes   = ["2145bdf698b8715039bd0e83f2069bed435ac21c"]
  sha256_hashes = ["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"]
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.AndroidApp;
import com.pulumi.gcp.firebase.AndroidAppArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var basic = new AndroidApp("basic", AndroidAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name Basic")
            .packageName("android.package.app")
            .sha1Hashes("2145bdf698b8715039bd0e83f2069bed435ac21c")
            .sha256Hashes("2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc")
            .build());

    }
}

resources:
  basic:
    type: gcp:firebase:AndroidApp
    properties:
      project: my-project-name
      displayName: Display Name Basic
      packageName: android.package.app
      sha1Hashes:
        - 2145bdf698b8715039bd0e83f2069bed435ac21c
      sha256Hashes:
        - 2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc

Firebase Android App Custom Api Key

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const android = new gcp.projects.ApiKey("android", {
    name: "api-key",
    displayName: "Display Name",
    project: "my-project-name",
    restrictions: {
        androidKeyRestrictions: {
            allowedApplications: [{
                packageName: "android.package.app",
                sha1Fingerprint: "2145bdf698b8715039bd0e83f2069bed435ac21c",
            }],
        },
    },
});
const _default = new gcp.firebase.AndroidApp("default", {
    project: "my-project-name",
    displayName: "Display Name",
    packageName: "android.package.app",
    sha1Hashes: ["2145bdf698b8715039bd0e83f2069bed435ac21c"],
    sha256Hashes: ["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"],
    apiKeyId: android.uid,
});

import pulumi
import pulumi_gcp as gcp

android = gcp.projects.ApiKey("android",
    name="api-key",
    display_name="Display Name",
    project="my-project-name",
    restrictions={
        "android_key_restrictions": {
            "allowed_applications": [{
                "package_name": "android.package.app",
                "sha1_fingerprint": "2145bdf698b8715039bd0e83f2069bed435ac21c",
            }],
        },
    })
default = gcp.firebase.AndroidApp("default",
    project="my-project-name",
    display_name="Display Name",
    package_name="android.package.app",
    sha1_hashes=["2145bdf698b8715039bd0e83f2069bed435ac21c"],
    sha256_hashes=["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"],
    api_key_id=android.uid)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var android = new Gcp.Projects.ApiKey("android", new()
    {
        Name = "api-key",
        DisplayName = "Display Name",
        Project = "my-project-name",
        Restrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsArgs
        {
            AndroidKeyRestrictions = new Gcp.Projects.Inputs.ApiKeyRestrictionsAndroidKeyRestrictionsArgs
            {
                AllowedApplications = new[]
                {
                    new Gcp.Projects.Inputs.ApiKeyRestrictionsAndroidKeyRestrictionsAllowedApplicationArgs
                    {
                        PackageName = "android.package.app",
                        Sha1Fingerprint = "2145bdf698b8715039bd0e83f2069bed435ac21c",
                    },
                },
            },
        },
    });

    var @default = new Gcp.Firebase.AndroidApp("default", new()
    {
        Project = "my-project-name",
        DisplayName = "Display Name",
        PackageName = "android.package.app",
        Sha1Hashes = new[]
        {
            "2145bdf698b8715039bd0e83f2069bed435ac21c",
        },
        Sha256Hashes = new[]
        {
            "2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc",
        },
        ApiKeyId = android.Uid,
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/firebase"
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		android, err := projects.NewApiKey(ctx, "android", &projects.ApiKeyArgs{
			Name:        pulumi.String("api-key"),
			DisplayName: pulumi.String("Display Name"),
			Project:     pulumi.String("my-project-name"),
			Restrictions: &projects.ApiKeyRestrictionsArgs{
				AndroidKeyRestrictions: &projects.ApiKeyRestrictionsAndroidKeyRestrictionsArgs{
					AllowedApplications: projects.ApiKeyRestrictionsAndroidKeyRestrictionsAllowedApplicationArray{
						&projects.ApiKeyRestrictionsAndroidKeyRestrictionsAllowedApplicationArgs{
							PackageName:     pulumi.String("android.package.app"),
							Sha1Fingerprint: pulumi.String("2145bdf698b8715039bd0e83f2069bed435ac21c"),
						},
					},
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = firebase.NewAndroidApp(ctx, "default", &firebase.AndroidAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Display Name"),
			PackageName: pulumi.String("android.package.app"),
			Sha1Hashes: pulumi.StringArray{
				pulumi.String("2145bdf698b8715039bd0e83f2069bed435ac21c"),
			},
			Sha256Hashes: pulumi.StringArray{
				pulumi.String("2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"),
			},
			ApiKeyId: android.Uid,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_firebase_androidapp" "default" {
  project       = "my-project-name"
  display_name  = "Display Name"
  package_name  = "android.package.app"
  sha1_hashes   = ["2145bdf698b8715039bd0e83f2069bed435ac21c"]
  sha256_hashes = ["2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc"]
  api_key_id    = gcp_projects_apikey.android.uid
}
resource "gcp_projects_apikey" "android" {
  name         = "api-key"
  display_name = "Display Name"
  project      = "my-project-name"
  restrictions = {
    android_key_restrictions = {
      allowed_applications = [{
        "packageName"     = "android.package.app"
        "sha1Fingerprint" = "2145bdf698b8715039bd0e83f2069bed435ac21c"
      }]
    }
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.ApiKey;
import com.pulumi.gcp.projects.ApiKeyArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsAndroidKeyRestrictionsArgs;
import com.pulumi.gcp.projects.inputs.ApiKeyRestrictionsAndroidKeyRestrictionsAllowedApplicationArgs;
import com.pulumi.gcp.firebase.AndroidApp;
import com.pulumi.gcp.firebase.AndroidAppArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var android = new ApiKey("android", ApiKeyArgs.builder()
            .name("api-key")
            .displayName("Display Name")
            .project("my-project-name")
            .restrictions(ApiKeyRestrictionsArgs.builder()
                .androidKeyRestrictions(ApiKeyRestrictionsAndroidKeyRestrictionsArgs.builder()
                    .allowedApplications(ApiKeyRestrictionsAndroidKeyRestrictionsAllowedApplicationArgs.builder()
                        .packageName("android.package.app")
                        .sha1Fingerprint("2145bdf698b8715039bd0e83f2069bed435ac21c")
                        .build())
                    .build())
                .build())
            .build());

        var default_ = new AndroidApp("default", AndroidAppArgs.builder()
            .project("my-project-name")
            .displayName("Display Name")
            .packageName("android.package.app")
            .sha1Hashes("2145bdf698b8715039bd0e83f2069bed435ac21c")
            .sha256Hashes("2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc")
            .apiKeyId(android.uid())
            .build());

    }
}

resources:
  default:
    type: gcp:firebase:AndroidApp
    properties:
      project: my-project-name
      displayName: Display Name
      packageName: android.package.app
      sha1Hashes:
        - 2145bdf698b8715039bd0e83f2069bed435ac21c
      sha256Hashes:
        - 2145bdf698b8715039bd0e83f2069bed435ac21ca1b2c3d4e5f6123456789abc
      apiKeyId: ${android.uid}
  android:
    type: gcp:projects:ApiKey
    properties:
      name: api-key
      displayName: Display Name
      project: my-project-name
      restrictions:
        androidKeyRestrictions:
          allowedApplications:
            - packageName: android.package.app
              sha1Fingerprint: 2145bdf698b8715039bd0e83f2069bed435ac21c

Import

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}}

When using the pulumi import command, AndroidApp can be imported using one of the formats above. For example:

$ terraform import google_firebase_android_app.default "{{project}} projects/{{project}}/androidApps/{{app_id}}"
$ pulumi import gcp:firebase/androidApp:AndroidApp default projects/{{project}}/androidApps/{{app_id}}
$ pulumi import gcp:firebase/androidApp:AndroidApp default {{project}}/{{project}}/{{app_id}}
$ pulumi import gcp:firebase/androidApp:AndroidApp default androidApps/{{app_id}}
$ pulumi import gcp:firebase/androidApp:AndroidApp default {{app_id}}

Constructors

AndroidApp(String name, {AndroidAppArgs? args, CustomResourceOptions? options})

Creates a new AndroidApp. name The Pulumi resource name. args Arguments used to configure this AndroidApp. The set of arguments for AndroidApp. options Resource options controlling this resource's behavior.

AndroidApp.reference(String urn)

Creates a typed reference to an existing AndroidApp resource.

Properties

apiKeyId ↔ Output<String>

The globally unique, Google-assigned identifier (UID) for the Firebase API key associated with the AndroidApp. If apiKeyId is not set during creation, then Firebase automatically associates an apiKeyId with the AndroidApp. This auto-associated key may be an existing valid key or, if no valid key exists, a new one will be provisioned.

late, final

appId ↔ Output<String>

The globally unique, Firebase-assigned identifier of the AndroidApp. This identifier should be treated as an opaque token, as the data format is not specified.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

The user-assigned display name of the AndroidApp.

late, final

etag ↔ Output<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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

name ↔ Output<String>

The fully qualified resource name of the AndroidApp, for example: projects/projectId/androidApps/appId

late, final

packageName ↔ Output<String>

The canonical package name of the Android app as would appear in the Google Play Developer Console.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

sha1Hashes ↔ Output<List<String>?>

The SHA1 certificate hashes for the AndroidApp.

late, final

sha256Hashes ↔ Output<List<String>?>

The SHA256 certificate hashes for the AndroidApp.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {AndroidAppState? state, CustomResourceOptions? options}) → AndroidApp

Gets an existing AndroidApp resource's state with the given name and id.