Docs
PackagesGoogle Cloud Classic v7.20.0 published on Wednesday, Apr 24, 2024 by Pulumi
gcp.firebase.AppCheckRecaptchaEnterpriseConfig
Explore with Pulumi AI
An app’s reCAPTCHA Enterprise configuration object.
To get more information about RecaptchaEnterpriseConfig, see:
- API documentation
- How-to Guides
Example Usage
Firebase App Check Recaptcha Enterprise 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 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"});
const defaultAppCheckRecaptchaEnterpriseConfig = new gcp.firebase.AppCheckRecaptchaEnterpriseConfig("default", {
project: "my-project-name",
appId: _default.appId,
siteKey: "6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw",
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 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.
wait30s = time.index.Sleep("wait_30s", create_duration=30s)
default_app_check_recaptcha_enterprise_config = gcp.firebase.AppCheckRecaptchaEnterpriseConfig("default",
project="my-project-name",
app_id=default.app_id,
site_key="6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw",
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 Enterprise"),
})
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.NewAppCheckRecaptchaEnterpriseConfig(ctx, "default", &firebase.AppCheckRecaptchaEnterpriseConfigArgs{
Project: pulumi.String("my-project-name"),
AppId: _default.AppId,
SiteKey: pulumi.String("6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw"),
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 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.
var wait30s = new Time.Index.Sleep("wait_30s", new()
{
CreateDuration = "30s",
});
var defaultAppCheckRecaptchaEnterpriseConfig = new Gcp.Firebase.AppCheckRecaptchaEnterpriseConfig("default", new()
{
Project = "my-project-name",
AppId = @default.AppId,
SiteKey = "6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw",
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.AppCheckRecaptchaEnterpriseConfig;
import com.pulumi.gcp.firebase.AppCheckRecaptchaEnterpriseConfigArgs;
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 Enterprise")
.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 defaultAppCheckRecaptchaEnterpriseConfig = new AppCheckRecaptchaEnterpriseConfig("defaultAppCheckRecaptchaEnterpriseConfig", AppCheckRecaptchaEnterpriseConfigArgs.builder()
.project("my-project-name")
.appId(default_.appId())
.siteKey("6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw")
.tokenTtl("7200s")
.build());
}
}
resources:
default:
type: gcp:firebase:WebApp
properties:
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.
wait30s:
type: time:sleep
name: wait_30s
properties:
createDuration: 30s
defaultAppCheckRecaptchaEnterpriseConfig:
type: gcp:firebase:AppCheckRecaptchaEnterpriseConfig
name: default
properties:
project: my-project-name
appId: ${default.appId}
siteKey: 6LdpMXIpAAAAANkwWQPgEdjEhal7ugkH9RK9ytuw
tokenTtl: 7200s
Create AppCheckRecaptchaEnterpriseConfig Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppCheckRecaptchaEnterpriseConfig(name: string, args: AppCheckRecaptchaEnterpriseConfigArgs, opts?: CustomResourceOptions);@overload
def AppCheckRecaptchaEnterpriseConfig(resource_name: str,
args: AppCheckRecaptchaEnterpriseConfigArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AppCheckRecaptchaEnterpriseConfig(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
site_key: Optional[str] = None,
project: Optional[str] = None,
token_ttl: Optional[str] = None)func NewAppCheckRecaptchaEnterpriseConfig(ctx *Context, name string, args AppCheckRecaptchaEnterpriseConfigArgs, opts ...ResourceOption) (*AppCheckRecaptchaEnterpriseConfig, error)public AppCheckRecaptchaEnterpriseConfig(string name, AppCheckRecaptchaEnterpriseConfigArgs args, CustomResourceOptions? opts = null)
public AppCheckRecaptchaEnterpriseConfig(String name, AppCheckRecaptchaEnterpriseConfigArgs args)
public AppCheckRecaptchaEnterpriseConfig(String name, AppCheckRecaptchaEnterpriseConfigArgs args, CustomResourceOptions options)
type: gcp:firebase:AppCheckRecaptchaEnterpriseConfig
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 AppCheckRecaptchaEnterpriseConfigArgs
- 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 AppCheckRecaptchaEnterpriseConfigArgs
- 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 AppCheckRecaptchaEnterpriseConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppCheckRecaptchaEnterpriseConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppCheckRecaptchaEnterpriseConfigArgs
- 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 appCheckRecaptchaEnterpriseConfigResource = new Gcp.Firebase.AppCheckRecaptchaEnterpriseConfig("appCheckRecaptchaEnterpriseConfigResource", new()
{
AppId = "string",
SiteKey = "string",
Project = "string",
TokenTtl = "string",
});
example, err := firebase.NewAppCheckRecaptchaEnterpriseConfig(ctx, "appCheckRecaptchaEnterpriseConfigResource", &firebase.AppCheckRecaptchaEnterpriseConfigArgs{
AppId: pulumi.String("string"),
SiteKey: pulumi.String("string"),
Project: pulumi.String("string"),
TokenTtl: pulumi.String("string"),
})
var appCheckRecaptchaEnterpriseConfigResource = new AppCheckRecaptchaEnterpriseConfig("appCheckRecaptchaEnterpriseConfigResource", AppCheckRecaptchaEnterpriseConfigArgs.builder()
.appId("string")
.siteKey("string")
.project("string")
.tokenTtl("string")
.build());
app_check_recaptcha_enterprise_config_resource = gcp.firebase.AppCheckRecaptchaEnterpriseConfig("appCheckRecaptchaEnterpriseConfigResource",
app_id="string",
site_key="string",
project="string",
token_ttl="string")
const appCheckRecaptchaEnterpriseConfigResource = new gcp.firebase.AppCheckRecaptchaEnterpriseConfig("appCheckRecaptchaEnterpriseConfigResource", {
appId: "string",
siteKey: "string",
project: "string",
tokenTtl: "string",
});
type: gcp:firebase:AppCheckRecaptchaEnterpriseConfig
properties:
appId: string
project: string
siteKey: string
tokenTtl: string
AppCheckRecaptchaEnterpriseConfig 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 AppCheckRecaptchaEnterpriseConfig resource accepts the following input properties:
- App
Id string - The ID of an
Web App.
- Site
Key string - 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Token
Ttl string - 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".
- App
Id string - The ID of an
Web App.
- Site
Key string - 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.
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Token
Ttl string - 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".
- app
Id String - The ID of an
Web App.
- site
Key String - 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- token
Ttl String - 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".
- app
Id string - The ID of an
Web App.
- site
Key string - 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.
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- token
Ttl string - 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".
- app_
id str - The ID of an
Web App.
- site_
key str - 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.
- 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 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".
- app
Id String - The ID of an
Web App.
- site
Key String - 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.
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- token
Ttl String - 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".
Outputs
All input properties are implicitly available as output properties. Additionally, the AppCheckRecaptchaEnterpriseConfig resource produces the following output properties:
Look up Existing AppCheckRecaptchaEnterpriseConfig Resource
Get an existing AppCheckRecaptchaEnterpriseConfig 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?: AppCheckRecaptchaEnterpriseConfigState, opts?: CustomResourceOptions): AppCheckRecaptchaEnterpriseConfig@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_key: Optional[str] = None,
token_ttl: Optional[str] = None) -> AppCheckRecaptchaEnterpriseConfigfunc GetAppCheckRecaptchaEnterpriseConfig(ctx *Context, name string, id IDInput, state *AppCheckRecaptchaEnterpriseConfigState, opts ...ResourceOption) (*AppCheckRecaptchaEnterpriseConfig, error)public static AppCheckRecaptchaEnterpriseConfig Get(string name, Input<string> id, AppCheckRecaptchaEnterpriseConfigState? state, CustomResourceOptions? opts = null)public static AppCheckRecaptchaEnterpriseConfig get(String name, Output<String> id, AppCheckRecaptchaEnterpriseConfigState 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.
- App
Id string - The ID of an
Web App.
- Name string
- The relative resource name of the reCAPTCHA Enterprise configuration object
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Site
Key string - 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.
- Token
Ttl string - 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".
- App
Id string - The ID of an
Web App.
- Name string
- The relative resource name of the reCAPTCHA Enterprise configuration object
- Project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Site
Key string - 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.
- Token
Ttl string - 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".
- app
Id String - The ID of an
Web App.
- name String
- The relative resource name of the reCAPTCHA Enterprise configuration object
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- site
Key String - 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.
- token
Ttl String - 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".
- app
Id string - The ID of an
Web App.
- name string
- The relative resource name of the reCAPTCHA Enterprise configuration object
- project string
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- site
Key string - 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.
- token
Ttl string - 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".
- app_
id str - The ID of an
Web App.
- name str
- The relative resource name of the reCAPTCHA Enterprise 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_
key str - 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.
- token_
ttl str - 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".
- app
Id String - The ID of an
Web App.
- name String
- The relative resource name of the reCAPTCHA Enterprise configuration object
- project String
- The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- site
Key String - 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.
- token
Ttl String - 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".
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:
$ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default projects/{{project}}/apps/{{app_id}}/recaptchaEnterpriseConfig
$ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig default {{project}}/{{app_id}}
$ pulumi import gcp:firebase/appCheckRecaptchaEnterpriseConfig:AppCheckRecaptchaEnterpriseConfig 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-betaTerraform Provider.