@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
244 lines (243 loc) • 9.25 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A Google Cloud Firebase Android application instance
*
* To get more information about AndroidApp, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.androidApps)
* * How-to Guides
* * [Official Documentation](https://firebase.google.com/docs/android/setup)
*
* ## Example Usage
*
* ### Firebase Android App Basic
*
* ```typescript
* 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"],
* });
* ```
* ### Firebase Android App Custom Api Key
*
* ```typescript
* 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
*
* 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:
*
* ```sh
* $ pulumi import gcp:firebase/androidApp:AndroidApp default "{{project}} projects/{{project}}/androidApps/{{app_id}}"
* ```
*
* ```sh
* $ pulumi import gcp:firebase/androidApp:AndroidApp default projects/{{project}}/androidApps/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/androidApp:AndroidApp default {{project}}/{{project}}/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/androidApp:AndroidApp default androidApps/{{app_id}}
* ```
*
* ```sh
* $ pulumi import gcp:firebase/androidApp:AndroidApp default {{app_id}}
* ```
*/
export declare class AndroidApp extends pulumi.CustomResource {
/**
* Get an existing AndroidApp resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AndroidAppState, opts?: pulumi.CustomResourceOptions): AndroidApp;
/**
* Returns true if the given object is an instance of AndroidApp. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AndroidApp;
/**
* 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.
*/
readonly apiKeyId: pulumi.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.
*/
readonly appId: pulumi.Output<string>;
readonly deletionPolicy: pulumi.Output<string | undefined>;
/**
* The user-assigned display name of the AndroidApp.
*/
readonly displayName: pulumi.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.
*/
readonly etag: pulumi.Output<string>;
/**
* The fully qualified resource name of the AndroidApp, for example:
* projects/projectId/androidApps/appId
*/
readonly name: pulumi.Output<string>;
/**
* The canonical package name of the Android app as would appear in the Google Play
* Developer Console.
*/
readonly packageName: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The SHA1 certificate hashes for the AndroidApp.
*/
readonly sha1Hashes: pulumi.Output<string[] | undefined>;
/**
* The SHA256 certificate hashes for the AndroidApp.
*/
readonly sha256Hashes: pulumi.Output<string[] | undefined>;
/**
* Create a AndroidApp resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AndroidAppArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AndroidApp resources.
*/
export interface AndroidAppState {
/**
* 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.
*/
apiKeyId?: pulumi.Input<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.
*/
appId?: pulumi.Input<string>;
deletionPolicy?: pulumi.Input<string>;
/**
* The user-assigned display name of the AndroidApp.
*/
displayName?: pulumi.Input<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.
*/
etag?: pulumi.Input<string>;
/**
* The fully qualified resource name of the AndroidApp, for example:
* projects/projectId/androidApps/appId
*/
name?: pulumi.Input<string>;
/**
* The canonical package name of the Android app as would appear in the Google Play
* Developer Console.
*/
packageName?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The SHA1 certificate hashes for the AndroidApp.
*/
sha1Hashes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The SHA256 certificate hashes for the AndroidApp.
*/
sha256Hashes?: pulumi.Input<pulumi.Input<string>[]>;
}
/**
* The set of arguments for constructing a AndroidApp resource.
*/
export interface AndroidAppArgs {
/**
* 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.
*/
apiKeyId?: pulumi.Input<string>;
deletionPolicy?: pulumi.Input<string>;
/**
* The user-assigned display name of the AndroidApp.
*/
displayName: pulumi.Input<string>;
/**
* The canonical package name of the Android app as would appear in the Google Play
* Developer Console.
*/
packageName: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The SHA1 certificate hashes for the AndroidApp.
*/
sha1Hashes?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The SHA256 certificate hashes for the AndroidApp.
*/
sha256Hashes?: pulumi.Input<pulumi.Input<string>[]>;
}