Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. firebase
  5. AppCheckRecaptchaV3Config
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.firebase.AppCheckRecaptchaV3Config

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
pulumi/pulumi-gcp

    An app’s reCAPTCHA V3 configuration object.

    To get more information about RecaptchaV3Config, see:

    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 "@pulumi/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.index.Sleep("wait_30s", {createDuration: "30s"});
const defaultAppCheckRecaptchaV3Config = new gcp.firebase.AppCheckRecaptchaV3Config("default", {
    project: "my-project-name",
    appId: _default.appId,
    siteSecret: "6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX",
    tokenTtl: "7200s",
});

    import pulumi
import pulumi_gcp as gcp
import pulumi_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.index.Sleep("wait_30s", create_duration=30s)
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")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, 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.
		_, err = time.NewSleep(ctx, "wait_30s", &time.SleepArgs{
			CreateDuration: "30s",
		})
		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"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Time = Pulumi.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.Index.Sleep("wait_30s", new()
    {
        CreateDuration = "30s",
    });

    var defaultAppCheckRecaptchaV3Config = new Gcp.Firebase.AppCheckRecaptchaV3Config("default", new()
    {
        Project = "my-project-name",
        AppId = @default.AppId,
        SiteSecret = "6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX",
        TokenTtl = "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.pulumi.time.sleep;
import com.pulumi.time.SleepArgs;
import com.pulumi.gcp.firebase.AppCheckRecaptchaV3Config;
import com.pulumi.gcp.firebase.AppCheckRecaptchaV3ConfigArgs;
import java.util.List;
import java.util.ArrayList;
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());

        var defaultAppCheckRecaptchaV3Config = new AppCheckRecaptchaV3Config("defaultAppCheckRecaptchaV3Config", AppCheckRecaptchaV3ConfigArgs.builder()        
            .project("my-project-name")
            .appId(default_.appId())
            .siteSecret("6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX")
            .tokenTtl("7200s")
            .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
  defaultAppCheckRecaptchaV3Config:
    type: gcp:firebase:AppCheckRecaptchaV3Config
    name: default
    properties:
      project: my-project-name
      appId: ${default.appId}
      siteSecret: 6Lf9YnQpAAAAAC3-MHmdAllTbPwTZxpUw5d34YzX
      tokenTtl: 7200s

    Create AppCheckRecaptchaV3Config Resource

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

    Constructor syntax

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

@overload
def AppCheckRecaptchaV3Config(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              app_id: Optional[str] = None,
                              site_secret: Optional[str] = None,
                              project: Optional[str] = None,
                              token_ttl: Optional[str] = None)
    func NewAppCheckRecaptchaV3Config(ctx *Context, name string, args AppCheckRecaptchaV3ConfigArgs, opts ...ResourceOption) (*AppCheckRecaptchaV3Config, error)
    public AppCheckRecaptchaV3Config(string name, AppCheckRecaptchaV3ConfigArgs args, CustomResourceOptions? opts = null)
    public AppCheckRecaptchaV3Config(String name, AppCheckRecaptchaV3ConfigArgs args)
public AppCheckRecaptchaV3Config(String name, AppCheckRecaptchaV3ConfigArgs args, CustomResourceOptions options)

    type: gcp:firebase:AppCheckRecaptchaV3Config
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 AppCheckRecaptchaV3ConfigArgs
    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 AppCheckRecaptchaV3ConfigArgs
    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 AppCheckRecaptchaV3ConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppCheckRecaptchaV3ConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppCheckRecaptchaV3ConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var appCheckRecaptchaV3ConfigResource = new Gcp.Firebase.AppCheckRecaptchaV3Config("appCheckRecaptchaV3ConfigResource", new()
{
    AppId = "string",
    SiteSecret = "string",
    Project = "string",
    TokenTtl = "string",
});

    example, err := firebase.NewAppCheckRecaptchaV3Config(ctx, "appCheckRecaptchaV3ConfigResource", &firebase.AppCheckRecaptchaV3ConfigArgs{
	AppId:      pulumi.String("string"),
	SiteSecret: pulumi.String("string"),
	Project:    pulumi.String("string"),
	TokenTtl:   pulumi.String("string"),
})

    var appCheckRecaptchaV3ConfigResource = new AppCheckRecaptchaV3Config("appCheckRecaptchaV3ConfigResource", AppCheckRecaptchaV3ConfigArgs.builder()        
    .appId("string")
    .siteSecret("string")
    .project("string")
    .tokenTtl("string")
    .build());

    app_check_recaptcha_v3_config_resource = gcp.firebase.AppCheckRecaptchaV3Config("appCheckRecaptchaV3ConfigResource",
    app_id="string",
    site_secret="string",
    project="string",
    token_ttl="string")

    const appCheckRecaptchaV3ConfigResource = new gcp.firebase.AppCheckRecaptchaV3Config("appCheckRecaptchaV3ConfigResource", {
    appId: "string",
    siteSecret: "string",
    project: "string",
    tokenTtl: "string",
});

    type: gcp:firebase:AppCheckRecaptchaV3Config
properties:
    appId: string
    project: string
    siteSecret: string
    tokenTtl: string

    AppCheckRecaptchaV3Config 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 AppCheckRecaptchaV3Config resource accepts the following input properties:

    AppId string
    The ID of an Web App.

    SiteSecret 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    TokenTtl 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".
    AppId string
    The ID of an Web App.

    SiteSecret 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.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    TokenTtl 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".
    appId String
    The ID of an Web App.

    siteSecret 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tokenTtl 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".
    appId string
    The ID of an Web App.

    siteSecret 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.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tokenTtl 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".
    app_id str
    The ID of an Web App.

    site_secret str
    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.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    token_ttl str
    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".
    appId String
    The ID of an Web App.

    siteSecret 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.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    tokenTtl 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".

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The relative resource name of the reCAPTCHA V3 configuration object
    SiteSecretSet 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The relative resource name of the reCAPTCHA V3 configuration object
    SiteSecretSet 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The relative resource name of the reCAPTCHA V3 configuration object
    siteSecretSet Boolean
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The relative resource name of the reCAPTCHA V3 configuration object
    siteSecretSet boolean
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The relative resource name of the reCAPTCHA V3 configuration object
    site_secret_set 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The relative resource name of the reCAPTCHA V3 configuration object
    siteSecretSet Boolean
    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.

    Look up Existing AppCheckRecaptchaV3Config Resource

    Get an existing AppCheckRecaptchaV3Config resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AppCheckRecaptchaV3ConfigState, opts?: CustomResourceOptions): AppCheckRecaptchaV3Config
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        app_id: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        site_secret: Optional[str] = None,
        site_secret_set: Optional[bool] = None,
        token_ttl: Optional[str] = None) -> AppCheckRecaptchaV3Config
    func GetAppCheckRecaptchaV3Config(ctx *Context, name string, id IDInput, state *AppCheckRecaptchaV3ConfigState, opts ...ResourceOption) (*AppCheckRecaptchaV3Config, error)
    public static AppCheckRecaptchaV3Config Get(string name, Input<string> id, AppCheckRecaptchaV3ConfigState? state, CustomResourceOptions? opts = null)
    public static AppCheckRecaptchaV3Config get(String name, Output<String> id, AppCheckRecaptchaV3ConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AppId string
    The ID of an Web App.

    Name string
    The relative resource name of the reCAPTCHA V3 configuration object
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SiteSecret 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.
    SiteSecretSet 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.
    TokenTtl 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".
    AppId string
    The ID of an Web App.

    Name string
    The relative resource name of the reCAPTCHA V3 configuration object
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    SiteSecret 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.
    SiteSecretSet 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.
    TokenTtl 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".
    appId String
    The ID of an Web App.

    name String
    The relative resource name of the reCAPTCHA V3 configuration object
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    siteSecret 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.
    siteSecretSet Boolean
    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.
    tokenTtl 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".
    appId string
    The ID of an Web App.

    name string
    The relative resource name of the reCAPTCHA V3 configuration object
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    siteSecret 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.
    siteSecretSet boolean
    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.
    tokenTtl 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".
    app_id str
    The ID of an Web App.

    name str
    The relative resource name of the reCAPTCHA V3 configuration object
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    site_secret str
    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.
    site_secret_set 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.
    token_ttl str
    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".
    appId String
    The ID of an Web App.

    name String
    The relative resource name of the reCAPTCHA V3 configuration object
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    siteSecret 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.
    siteSecretSet Boolean
    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.
    tokenTtl 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".

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
    pulumi/pulumi-gcp