import * as pulumi from "@pulumi/pulumi"; /** * An app's reCAPTCHA Enterprise configuration object. * * To get more information about RecaptchaEnterpriseConfig, see: * * * [API documentation](https://firebase.google.com/docs/reference/appcheck/rest/v1/projects.apps.recaptchaEnterpriseConfig) * * How-to Guides * * [Official Documentation](https://firebase.google.com/docs/app-check) * * ## Example Usage * * ### Firebase App Check Recaptcha Enterprise Config Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * import * as time from "@pulumi/time"; * * // Enables the reCAPTCHA Enterprise API * const recaptchaEnterprise = new gcp.projects.Service("recaptcha_enterprise", { * project: "my-project-name", * service: "recaptchaenterprise.googleapis.com", * disableOnDestroy: false, * }); * const _default = new gcp.firebase.WebApp("default", { * project: "my-project-name", * displayName: "Web App for reCAPTCHA Enterprise", * }); * // It takes a while for App Check to recognize the new app * // If your app already exists, you don't have to wait 30 seconds. * const wait30s = new time.index.Sleep("wait_30s", {createDuration: "30s"}, { * dependsOn: [_default], * }); * const defaultAppCheckRecaptchaEnterpriseConfig = new gcp.firebase.AppCheckRecaptchaEnterpriseConfig("default", { * project: "my-project-name", * appId: _default.appId, * siteKey: "6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw", * tokenTtl: "7200s", * }, { * dependsOn: [wait30s], * }); * ``` * * ## Import * * RecaptchaEnterpriseConfig can be imported using any of these accepted formats: * * * `projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig` * * * `{{project}}/{{app_id}}` * * * `{{app_id}}` * * When using the `pulumi import` command, RecaptchaEnterpriseConfig can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig * ``` * * ```sh * $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{project}}/{{app_id}} * ``` * * ```sh * $ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{app_id}} * ``` */ export declare class AppCheckRecaptchaEnterpriseConfig extends pulumi.CustomResource { /** * Get an existing AppCheckRecaptchaEnterpriseConfig 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, state?: AppCheckRecaptchaEnterpriseConfigState, opts?: pulumi.CustomResourceOptions): AppCheckRecaptchaEnterpriseConfig; /** * Returns true if the given object is an instance of AppCheckRecaptchaEnterpriseConfig. 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 AppCheckRecaptchaEnterpriseConfig; /** * The ID of an * [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id). * * * - - - */ readonly appId: pulumi.Output; /** * The relative resource name of the reCAPTCHA Enterprise configuration object */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application. * **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. */ readonly siteKey: pulumi.Output; /** * Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid. * If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. * A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". */ readonly tokenTtl: pulumi.Output; /** * Create a AppCheckRecaptchaEnterpriseConfig 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: AppCheckRecaptchaEnterpriseConfigArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering AppCheckRecaptchaEnterpriseConfig resources. */ export interface AppCheckRecaptchaEnterpriseConfigState { /** * The ID of an * [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id). * * * - - - */ appId?: pulumi.Input; /** * The relative resource name of the reCAPTCHA Enterprise configuration object */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application. * **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. */ siteKey?: pulumi.Input; /** * Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid. * If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. * A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". */ tokenTtl?: pulumi.Input; } /** * The set of arguments for constructing a AppCheckRecaptchaEnterpriseConfig resource. */ export interface AppCheckRecaptchaEnterpriseConfigArgs { /** * The ID of an * [Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id). * * * - - - */ appId: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The score-based site key created in reCAPTCHA Enterprise used to invoke reCAPTCHA and generate the reCAPTCHA tokens for your application. * **Important**: This is not the siteSecret (as it is in reCAPTCHA v3), but rather your score-based reCAPTCHA Enterprise site key. */ siteKey: pulumi.Input; /** * Specifies the duration for which App Check tokens exchanged from reCAPTCHA Enterprise artifacts will be valid. * If unset, a default value of 1 hour is assumed. Must be between 30 minutes and 7 days, inclusive. * A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s". */ tokenTtl?: pulumi.Input; }