AppCheckRecaptchaV3Config class

An app's reCAPTCHA V3 configuration object.

To get more information about RecaptchaV3Config, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Firebase App Check Recaptcha V3 Config Basic

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

const _default = new gcp.firebase.WebApp("default", {
    project: "my-project-name",
    displayName: "Web App for reCAPTCHA V3",
});
// 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.Sleep("wait_30s", {createDuration: "30s"}, {
    dependsOn: [_default],
});
const defaultAppCheckRecaptchaV3Config = new gcp.firebase.AppCheckRecaptchaV3Config("default", {
    project: "my-project-name",
    appId: _default.appId,
    siteSecret: "6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX",
    tokenTtl: "7200s",
}, {
    dependsOn: [wait30s],
});

import pulumi
import pulumi_gcp as gcp
import pulumiverse_time as time

default = gcp.firebase.WebApp("default",
    project="my-project-name",
    display_name="Web App for reCAPTCHA V3")
# 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.
wait30s = time.Sleep("wait_30s", create_duration="30s",
opts = pulumi.ResourceOptions(depends_on=[default]))
default_app_check_recaptcha_v3_config = gcp.firebase.AppCheckRecaptchaV3Config("default",
    project="my-project-name",
    app_id=default.app_id,
    site_secret="6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX",
    token_ttl="7200s",
    opts = pulumi.ResourceOptions(depends_on=[wait30s]))

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

return await Deployment.RunAsync(() =>
{
    var @default = new Gcp.Firebase.WebApp("default", new()
    {
        Project = "my-project-name",
        DisplayName = "Web App for reCAPTCHA V3",
    });

    // 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.
    var wait30s = new Time.Sleep("wait_30s", new()
    {
        CreateDuration = "30s",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            @default,
        },
    });

    var defaultAppCheckRecaptchaV3Config = new Gcp.Firebase.AppCheckRecaptchaV3Config("default", new()
    {
        Project = "my-project-name",
        AppId = @default.AppId,
        SiteSecret = "6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX",
        TokenTtl = "7200s",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            wait30s,
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := firebase.NewWebApp(ctx, "default", &firebase.WebAppArgs{
			Project:     pulumi.String("my-project-name"),
			DisplayName: pulumi.String("Web App for reCAPTCHA V3"),
		})
		if err != nil {
			return err
		}
		// 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.
		wait30s, err := time.NewSleep(ctx, "wait_30s", &time.SleepArgs{
			CreateDuration: pulumi.String("30s"),
		}, pulumi.DependsOn([]pulumi.Resource{
			_default,
		}))
		if err != nil {
			return err
		}
		_, err = firebase.NewAppCheckRecaptchaV3Config(ctx, "default", &firebase.AppCheckRecaptchaV3ConfigArgs{
			Project:    pulumi.String("my-project-name"),
			AppId:      _default.AppId,
			SiteSecret: pulumi.String("6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX"),
			TokenTtl:   pulumi.String("7200s"),
		}, pulumi.DependsOn([]pulumi.Resource{
			wait30s,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_firebase_webapp" "default" {
  project      = "my-project-name"
  display_name = "Web App for reCAPTCHA V3"
}
# 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.
resource "time_sleep" "wait_30s" {
  depends_on      = [gcp_firebase_webapp.default]
  create_duration = "30s"
}
resource "gcp_firebase_appcheckrecaptchav3config" "default" {
  depends_on  = [time_sleep.wait_30s]
  project     = "my-project-name"
  app_id      = gcp_firebase_webapp.default.app_id
  site_secret = "6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX"
  token_ttl   = "7200s"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.firebase.WebApp;
import com.pulumi.gcp.firebase.WebAppArgs;
import com.pulumiverse.time.Sleep;
import com.pulumiverse.time.SleepArgs;
import com.pulumi.gcp.firebase.AppCheckRecaptchaV3Config;
import com.pulumi.gcp.firebase.AppCheckRecaptchaV3ConfigArgs;
import com.pulumi.resources.CustomResourceOptions;
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 default_ = new WebApp("default", WebAppArgs.builder()
            .project("my-project-name")
            .displayName("Web App for reCAPTCHA V3")
            .build());

        // 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.
        var wait30s = new Sleep("wait30s", SleepArgs.builder()
            .createDuration("30s")
            .build(), CustomResourceOptions.builder()
                .dependsOn(default_)
                .build());

        var defaultAppCheckRecaptchaV3Config = new AppCheckRecaptchaV3Config("defaultAppCheckRecaptchaV3Config", AppCheckRecaptchaV3ConfigArgs.builder()
            .project("my-project-name")
            .appId(default_.appId())
            .siteSecret("6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX")
            .tokenTtl("7200s")
            .build(), CustomResourceOptions.builder()
                .dependsOn(wait30s)
                .build());

    }
}

resources:
  default:
    type: gcp:firebase:WebApp
    properties:
      project: my-project-name
      displayName: Web App for reCAPTCHA V3
  # 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.
  wait30s:
    type: time:Sleep
    name: wait_30s
    properties:
      createDuration: 30s
    options:
      dependsOn:
        - ${default}
  defaultAppCheckRecaptchaV3Config:
    type: gcp:firebase:AppCheckRecaptchaV3Config
    name: default
    properties:
      project: my-project-name
      appId: ${default.appId}
      siteSecret: 6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX
      tokenTtl: 7200s
    options:
      dependsOn:
        - ${wait30s}

Import

RecaptchaV3Config can be imported using any of these accepted formats:

• projects/{{project}}/apps/{{app_id}}/recaptchaV3Config
• {{project}}/{{app_id}}
• {{app_id}}

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

$ pulumi import gcp:firebase/appCheckRecaptchaV3Config:AppCheckRecaptchaV3Config default projects/{{project}}/apps/{{app_id}}/recaptchaV3Config
$ pulumi import gcp:firebase/appCheckRecaptchaV3Config:AppCheckRecaptchaV3Config default {{project}}/{{app_id}}
$ pulumi import gcp:firebase/appCheckRecaptchaV3Config:AppCheckRecaptchaV3Config default {{app_id}}

Constructors

AppCheckRecaptchaV3Config(String name, {AppCheckRecaptchaV3ConfigArgs? args, CustomResourceOptions? options})

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

AppCheckRecaptchaV3Config.reference(String urn)

Creates a typed reference to an existing AppCheckRecaptchaV3Config resource.

Properties

appId ↔ Output<String>

The ID of an Web App.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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 relative resource name of the reCAPTCHA V3 configuration object

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

siteSecret ↔ Output<String>

The site secret used to identify your service for reCAPTCHA v3 verification. For security reasons, this field will never be populated in any response. Note: This property is sensitive and will not be displayed in the plan.

late, final

siteSecretSet ↔ Output<bool>

Whether the siteSecret was previously set. Since we will never return the siteSecret field, this field is the only way to find out whether it was previously set.

late, final

tokenTtl ↔ Output<String>

Specifies the duration for which App Check tokens exchanged from reCAPTCHA V3 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".

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, {AppCheckRecaptchaV3ConfigState? state, CustomResourceOptions? options}) → AppCheckRecaptchaV3Config

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