Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. recaptcha
  5. EnterpriseKey
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.recaptcha.EnterpriseKey

Explore with Pulumi AI

Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp

The RecaptchaEnterprise Key resource

Example Usage

Android_key

A basic test of recaptcha enterprise key that can be used by Android apps

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    androidSettings: {
        allowAllPackageNames: true,
        allowedPackageNames: [],
    },
    project: "my-project-name",
    testingOptions: {
        testingScore: 0.8,
    },
    labels: {
        "label-one": "value-one",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    android_settings={
        "allow_all_package_names": True,
        "allowed_package_names": [],
    },
    project="my-project-name",
    testing_options={
        "testing_score": 0.8,
    },
    labels={
        "label-one": "value-one",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			AndroidSettings: &recaptcha.EnterpriseKeyAndroidSettingsArgs{
				AllowAllPackageNames: pulumi.Bool(true),
				AllowedPackageNames:  pulumi.StringArray{},
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(0.8),
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        AndroidSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyAndroidSettingsArgs
        {
            AllowAllPackageNames = true,
            AllowedPackageNames = new() { },
        },
        Project = "my-project-name",
        TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
        {
            TestingScore = 0.8,
        },
        Labels = 
        {
            { "label-one", "value-one" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyAndroidSettingsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyTestingOptionsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .androidSettings(EnterpriseKeyAndroidSettingsArgs.builder()
                .allowAllPackageNames(true)
                .allowedPackageNames()
                .build())
            .project("my-project-name")
            .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                .testingScore(0.8)
                .build())
            .labels(Map.of("label-one", "value-one"))
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      androidSettings:
        allowAllPackageNames: true
        allowedPackageNames: []
      project: my-project-name
      testingOptions:
        testingScore: 0.8
      labels:
        label-one: value-one
Copy

Ios_key

A basic test of recaptcha enterprise key that can be used by iOS apps

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    iosSettings: {
        allowAllBundleIds: true,
        allowedBundleIds: [],
    },
    project: "my-project-name",
    testingOptions: {
        testingScore: 1,
    },
    labels: {
        "label-one": "value-one",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    ios_settings={
        "allow_all_bundle_ids": True,
        "allowed_bundle_ids": [],
    },
    project="my-project-name",
    testing_options={
        "testing_score": 1,
    },
    labels={
        "label-one": "value-one",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			IosSettings: &recaptcha.EnterpriseKeyIosSettingsArgs{
				AllowAllBundleIds: pulumi.Bool(true),
				AllowedBundleIds:  pulumi.StringArray{},
			},
			Project: pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(1),
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        IosSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyIosSettingsArgs
        {
            AllowAllBundleIds = true,
            AllowedBundleIds = new() { },
        },
        Project = "my-project-name",
        TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
        {
            TestingScore = 1,
        },
        Labels = 
        {
            { "label-one", "value-one" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyIosSettingsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyTestingOptionsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .iosSettings(EnterpriseKeyIosSettingsArgs.builder()
                .allowAllBundleIds(true)
                .allowedBundleIds()
                .build())
            .project("my-project-name")
            .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                .testingScore(1)
                .build())
            .labels(Map.of("label-one", "value-one"))
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      iosSettings:
        allowAllBundleIds: true
        allowedBundleIds: []
      project: my-project-name
      testingOptions:
        testingScore: 1
      labels:
        label-one: value-one
Copy

Minimal_key

A minimal test of recaptcha enterprise key

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    project: "my-project-name",
    webSettings: {
        integrationType: "SCORE",
        allowAllDomains: true,
    },
    labels: {},
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    project="my-project-name",
    web_settings={
        "integration_type": "SCORE",
        "allow_all_domains": True,
    },
    labels={})
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Project:     pulumi.String("my-project-name"),
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				IntegrationType: pulumi.String("SCORE"),
				AllowAllDomains: pulumi.Bool(true),
			},
			Labels: pulumi.StringMap{},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        Project = "my-project-name",
        WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
        {
            IntegrationType = "SCORE",
            AllowAllDomains = true,
        },
        Labels = null,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyWebSettingsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .project("my-project-name")
            .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                .integrationType("SCORE")
                .allowAllDomains(true)
                .build())
            .labels()
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      project: my-project-name
      webSettings:
        integrationType: SCORE
        allowAllDomains: true
      labels: {}
Copy

Waf_key

A basic test of recaptcha enterprise key that includes WAF settings

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    project: "my-project-name",
    testingOptions: {
        testingChallenge: "NOCAPTCHA",
        testingScore: 0.5,
    },
    wafSettings: {
        wafFeature: "CHALLENGE_PAGE",
        wafService: "CA",
    },
    webSettings: {
        integrationType: "INVISIBLE",
        allowAllDomains: true,
        allowedDomains: [],
        challengeSecurityPreference: "USABILITY",
    },
    labels: {
        "label-one": "value-one",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    project="my-project-name",
    testing_options={
        "testing_challenge": "NOCAPTCHA",
        "testing_score": 0.5,
    },
    waf_settings={
        "waf_feature": "CHALLENGE_PAGE",
        "waf_service": "CA",
    },
    web_settings={
        "integration_type": "INVISIBLE",
        "allow_all_domains": True,
        "allowed_domains": [],
        "challenge_security_preference": "USABILITY",
    },
    labels={
        "label-one": "value-one",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Project:     pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingChallenge: pulumi.String("NOCAPTCHA"),
				TestingScore:     pulumi.Float64(0.5),
			},
			WafSettings: &recaptcha.EnterpriseKeyWafSettingsArgs{
				WafFeature: pulumi.String("CHALLENGE_PAGE"),
				WafService: pulumi.String("CA"),
			},
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				IntegrationType:             pulumi.String("INVISIBLE"),
				AllowAllDomains:             pulumi.Bool(true),
				AllowedDomains:              pulumi.StringArray{},
				ChallengeSecurityPreference: pulumi.String("USABILITY"),
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        Project = "my-project-name",
        TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
        {
            TestingChallenge = "NOCAPTCHA",
            TestingScore = 0.5,
        },
        WafSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWafSettingsArgs
        {
            WafFeature = "CHALLENGE_PAGE",
            WafService = "CA",
        },
        WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
        {
            IntegrationType = "INVISIBLE",
            AllowAllDomains = true,
            AllowedDomains = new() { },
            ChallengeSecurityPreference = "USABILITY",
        },
        Labels = 
        {
            { "label-one", "value-one" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyTestingOptionsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyWafSettingsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyWebSettingsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .project("my-project-name")
            .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                .testingChallenge("NOCAPTCHA")
                .testingScore(0.5)
                .build())
            .wafSettings(EnterpriseKeyWafSettingsArgs.builder()
                .wafFeature("CHALLENGE_PAGE")
                .wafService("CA")
                .build())
            .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                .integrationType("INVISIBLE")
                .allowAllDomains(true)
                .allowedDomains()
                .challengeSecurityPreference("USABILITY")
                .build())
            .labels(Map.of("label-one", "value-one"))
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      project: my-project-name
      testingOptions:
        testingChallenge: NOCAPTCHA
        testingScore: 0.5
      wafSettings:
        wafFeature: CHALLENGE_PAGE
        wafService: CA
      webSettings:
        integrationType: INVISIBLE
        allowAllDomains: true
        allowedDomains: []
        challengeSecurityPreference: USABILITY
      labels:
        label-one: value-one
Copy

Web_key

A basic test of recaptcha enterprise key that can be used by websites

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    project: "my-project-name",
    testingOptions: {
        testingChallenge: "NOCAPTCHA",
        testingScore: 0.5,
    },
    webSettings: {
        integrationType: "CHECKBOX",
        allowAllDomains: true,
        allowedDomains: [],
        challengeSecurityPreference: "USABILITY",
    },
    labels: {
        "label-one": "value-one",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    project="my-project-name",
    testing_options={
        "testing_challenge": "NOCAPTCHA",
        "testing_score": 0.5,
    },
    web_settings={
        "integration_type": "CHECKBOX",
        "allow_all_domains": True,
        "allowed_domains": [],
        "challenge_security_preference": "USABILITY",
    },
    labels={
        "label-one": "value-one",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Project:     pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingChallenge: pulumi.String("NOCAPTCHA"),
				TestingScore:     pulumi.Float64(0.5),
			},
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				IntegrationType:             pulumi.String("CHECKBOX"),
				AllowAllDomains:             pulumi.Bool(true),
				AllowedDomains:              pulumi.StringArray{},
				ChallengeSecurityPreference: pulumi.String("USABILITY"),
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        Project = "my-project-name",
        TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
        {
            TestingChallenge = "NOCAPTCHA",
            TestingScore = 0.5,
        },
        WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
        {
            IntegrationType = "CHECKBOX",
            AllowAllDomains = true,
            AllowedDomains = new() { },
            ChallengeSecurityPreference = "USABILITY",
        },
        Labels = 
        {
            { "label-one", "value-one" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyTestingOptionsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyWebSettingsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .project("my-project-name")
            .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                .testingChallenge("NOCAPTCHA")
                .testingScore(0.5)
                .build())
            .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                .integrationType("CHECKBOX")
                .allowAllDomains(true)
                .allowedDomains()
                .challengeSecurityPreference("USABILITY")
                .build())
            .labels(Map.of("label-one", "value-one"))
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      project: my-project-name
      testingOptions:
        testingChallenge: NOCAPTCHA
        testingScore: 0.5
      webSettings:
        integrationType: CHECKBOX
        allowAllDomains: true
        allowedDomains: []
        challengeSecurityPreference: USABILITY
      labels:
        label-one: value-one
Copy

Web_score_key

A basic test of recaptcha enterprise key with score integration type that can be used by websites

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

const primary = new gcp.recaptcha.EnterpriseKey("primary", {
    displayName: "display-name-one",
    project: "my-project-name",
    testingOptions: {
        testingScore: 0.5,
    },
    webSettings: {
        integrationType: "SCORE",
        allowAllDomains: true,
        allowAmpTraffic: false,
        allowedDomains: [],
    },
    labels: {
        "label-one": "value-one",
    },
});
Copy
import pulumi
import pulumi_gcp as gcp

primary = gcp.recaptcha.EnterpriseKey("primary",
    display_name="display-name-one",
    project="my-project-name",
    testing_options={
        "testing_score": 0.5,
    },
    web_settings={
        "integration_type": "SCORE",
        "allow_all_domains": True,
        "allow_amp_traffic": False,
        "allowed_domains": [],
    },
    labels={
        "label-one": "value-one",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/recaptcha"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := recaptcha.NewEnterpriseKey(ctx, "primary", &recaptcha.EnterpriseKeyArgs{
			DisplayName: pulumi.String("display-name-one"),
			Project:     pulumi.String("my-project-name"),
			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
				TestingScore: pulumi.Float64(0.5),
			},
			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
				IntegrationType: pulumi.String("SCORE"),
				AllowAllDomains: pulumi.Bool(true),
				AllowAmpTraffic: pulumi.Bool(false),
				AllowedDomains:  pulumi.StringArray{},
			},
			Labels: pulumi.StringMap{
				"label-one": pulumi.String("value-one"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var primary = new Gcp.Recaptcha.EnterpriseKey("primary", new()
    {
        DisplayName = "display-name-one",
        Project = "my-project-name",
        TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
        {
            TestingScore = 0.5,
        },
        WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
        {
            IntegrationType = "SCORE",
            AllowAllDomains = true,
            AllowAmpTraffic = false,
            AllowedDomains = new() { },
        },
        Labels = 
        {
            { "label-one", "value-one" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.recaptcha.EnterpriseKey;
import com.pulumi.gcp.recaptcha.EnterpriseKeyArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyTestingOptionsArgs;
import com.pulumi.gcp.recaptcha.inputs.EnterpriseKeyWebSettingsArgs;
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 primary = new EnterpriseKey("primary", EnterpriseKeyArgs.builder()
            .displayName("display-name-one")
            .project("my-project-name")
            .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                .testingScore(0.5)
                .build())
            .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                .integrationType("SCORE")
                .allowAllDomains(true)
                .allowAmpTraffic(false)
                .allowedDomains()
                .build())
            .labels(Map.of("label-one", "value-one"))
            .build());

    }
}
Copy
resources:
  primary:
    type: gcp:recaptcha:EnterpriseKey
    properties:
      displayName: display-name-one
      project: my-project-name
      testingOptions:
        testingScore: 0.5
      webSettings:
        integrationType: SCORE
        allowAllDomains: true
        allowAmpTraffic: false
        allowedDomains: []
      labels:
        label-one: value-one
Copy

Create EnterpriseKey Resource

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

Constructor syntax

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

@overload
def EnterpriseKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  display_name: Optional[str] = None,
                  android_settings: Optional[EnterpriseKeyAndroidSettingsArgs] = None,
                  ios_settings: Optional[EnterpriseKeyIosSettingsArgs] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  project: Optional[str] = None,
                  testing_options: Optional[EnterpriseKeyTestingOptionsArgs] = None,
                  waf_settings: Optional[EnterpriseKeyWafSettingsArgs] = None,
                  web_settings: Optional[EnterpriseKeyWebSettingsArgs] = None)
func NewEnterpriseKey(ctx *Context, name string, args EnterpriseKeyArgs, opts ...ResourceOption) (*EnterpriseKey, error)
public EnterpriseKey(string name, EnterpriseKeyArgs args, CustomResourceOptions? opts = null)
public EnterpriseKey(String name, EnterpriseKeyArgs args)
public EnterpriseKey(String name, EnterpriseKeyArgs args, CustomResourceOptions options)

type: gcp:recaptcha:EnterpriseKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EnterpriseKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EnterpriseKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EnterpriseKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var enterpriseKeyResource = new Gcp.Recaptcha.EnterpriseKey("enterpriseKeyResource", new()
{
    DisplayName = "string",
    AndroidSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyAndroidSettingsArgs
    {
        AllowAllPackageNames = false,
        AllowedPackageNames = new[]
        {
            "string",
        },
    },
    IosSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyIosSettingsArgs
    {
        AllowAllBundleIds = false,
        AllowedBundleIds = new[]
        {
            "string",
        },
    },
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
    TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
    {
        TestingChallenge = "string",
        TestingScore = 0,
    },
    WafSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWafSettingsArgs
    {
        WafFeature = "string",
        WafService = "string",
    },
    WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
    {
        IntegrationType = "string",
        AllowAllDomains = false,
        AllowAmpTraffic = false,
        AllowedDomains = new[]
        {
            "string",
        },
        ChallengeSecurityPreference = "string",
    },
});
Copy
example, err := recaptcha.NewEnterpriseKey(ctx, "enterpriseKeyResource", &recaptcha.EnterpriseKeyArgs{
	DisplayName: pulumi.String("string"),
	AndroidSettings: &recaptcha.EnterpriseKeyAndroidSettingsArgs{
		AllowAllPackageNames: pulumi.Bool(false),
		AllowedPackageNames: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	IosSettings: &recaptcha.EnterpriseKeyIosSettingsArgs{
		AllowAllBundleIds: pulumi.Bool(false),
		AllowedBundleIds: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
	TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
		TestingChallenge: pulumi.String("string"),
		TestingScore:     pulumi.Float64(0),
	},
	WafSettings: &recaptcha.EnterpriseKeyWafSettingsArgs{
		WafFeature: pulumi.String("string"),
		WafService: pulumi.String("string"),
	},
	WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
		IntegrationType: pulumi.String("string"),
		AllowAllDomains: pulumi.Bool(false),
		AllowAmpTraffic: pulumi.Bool(false),
		AllowedDomains: pulumi.StringArray{
			pulumi.String("string"),
		},
		ChallengeSecurityPreference: pulumi.String("string"),
	},
})
Copy
var enterpriseKeyResource = new EnterpriseKey("enterpriseKeyResource", EnterpriseKeyArgs.builder()
    .displayName("string")
    .androidSettings(EnterpriseKeyAndroidSettingsArgs.builder()
        .allowAllPackageNames(false)
        .allowedPackageNames("string")
        .build())
    .iosSettings(EnterpriseKeyIosSettingsArgs.builder()
        .allowAllBundleIds(false)
        .allowedBundleIds("string")
        .build())
    .labels(Map.of("string", "string"))
    .project("string")
    .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
        .testingChallenge("string")
        .testingScore(0)
        .build())
    .wafSettings(EnterpriseKeyWafSettingsArgs.builder()
        .wafFeature("string")
        .wafService("string")
        .build())
    .webSettings(EnterpriseKeyWebSettingsArgs.builder()
        .integrationType("string")
        .allowAllDomains(false)
        .allowAmpTraffic(false)
        .allowedDomains("string")
        .challengeSecurityPreference("string")
        .build())
    .build());
Copy
enterprise_key_resource = gcp.recaptcha.EnterpriseKey("enterpriseKeyResource",
    display_name="string",
    android_settings={
        "allow_all_package_names": False,
        "allowed_package_names": ["string"],
    },
    ios_settings={
        "allow_all_bundle_ids": False,
        "allowed_bundle_ids": ["string"],
    },
    labels={
        "string": "string",
    },
    project="string",
    testing_options={
        "testing_challenge": "string",
        "testing_score": 0,
    },
    waf_settings={
        "waf_feature": "string",
        "waf_service": "string",
    },
    web_settings={
        "integration_type": "string",
        "allow_all_domains": False,
        "allow_amp_traffic": False,
        "allowed_domains": ["string"],
        "challenge_security_preference": "string",
    })
Copy
const enterpriseKeyResource = new gcp.recaptcha.EnterpriseKey("enterpriseKeyResource", {
    displayName: "string",
    androidSettings: {
        allowAllPackageNames: false,
        allowedPackageNames: ["string"],
    },
    iosSettings: {
        allowAllBundleIds: false,
        allowedBundleIds: ["string"],
    },
    labels: {
        string: "string",
    },
    project: "string",
    testingOptions: {
        testingChallenge: "string",
        testingScore: 0,
    },
    wafSettings: {
        wafFeature: "string",
        wafService: "string",
    },
    webSettings: {
        integrationType: "string",
        allowAllDomains: false,
        allowAmpTraffic: false,
        allowedDomains: ["string"],
        challengeSecurityPreference: "string",
    },
});
Copy
type: gcp:recaptcha:EnterpriseKey
properties:
    androidSettings:
        allowAllPackageNames: false
        allowedPackageNames:
            - string
    displayName: string
    iosSettings:
        allowAllBundleIds: false
        allowedBundleIds:
            - string
    labels:
        string: string
    project: string
    testingOptions:
        testingChallenge: string
        testingScore: 0
    wafSettings:
        wafFeature: string
        wafService: string
    webSettings:
        allowAllDomains: false
        allowAmpTraffic: false
        allowedDomains:
            - string
        challengeSecurityPreference: string
        integrationType: string
Copy

EnterpriseKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EnterpriseKey resource accepts the following input properties:

DisplayName This property is required. string
Human-readable display name of this key. Modifiable by user.

AndroidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
IosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
Labels Dictionary<string, string>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Project Changes to this property will trigger replacement. string
The project for the resource
TestingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
WafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
WebSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
DisplayName This property is required. string
Human-readable display name of this key. Modifiable by user.

AndroidSettings EnterpriseKeyAndroidSettingsArgs
Settings for keys that can be used by Android apps.
IosSettings EnterpriseKeyIosSettingsArgs
Settings for keys that can be used by iOS apps.
Labels map[string]string

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Project Changes to this property will trigger replacement. string
The project for the resource
TestingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptionsArgs
Options for user acceptance testing.
WafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettingsArgs
Settings specific to keys that can be used for WAF (Web Application Firewall).
WebSettings EnterpriseKeyWebSettingsArgs
Settings for keys that can be used by websites.
displayName This property is required. String
Human-readable display name of this key. Modifiable by user.

androidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
iosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
labels Map<String,String>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project Changes to this property will trigger replacement. String
The project for the resource
testingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
displayName This property is required. string
Human-readable display name of this key. Modifiable by user.

androidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
iosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
labels {[key: string]: string}

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project Changes to this property will trigger replacement. string
The project for the resource
testingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
display_name This property is required. str
Human-readable display name of this key. Modifiable by user.

android_settings EnterpriseKeyAndroidSettingsArgs
Settings for keys that can be used by Android apps.
ios_settings EnterpriseKeyIosSettingsArgs
Settings for keys that can be used by iOS apps.
labels Mapping[str, str]

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project Changes to this property will trigger replacement. str
The project for the resource
testing_options Changes to this property will trigger replacement. EnterpriseKeyTestingOptionsArgs
Options for user acceptance testing.
waf_settings Changes to this property will trigger replacement. EnterpriseKeyWafSettingsArgs
Settings specific to keys that can be used for WAF (Web Application Firewall).
web_settings EnterpriseKeyWebSettingsArgs
Settings for keys that can be used by websites.
displayName This property is required. String
Human-readable display name of this key. Modifiable by user.

androidSettings Property Map
Settings for keys that can be used by Android apps.
iosSettings Property Map
Settings for keys that can be used by iOS apps.
labels Map<String>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

project Changes to this property will trigger replacement. String
The project for the resource
testingOptions Changes to this property will trigger replacement. Property Map
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. Property Map
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings Property Map
Settings for keys that can be used by websites.

Outputs

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

CreateTime string
The timestamp corresponding to the creation of this Key.
EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource id for the Key, which is the same as the Site Key itself.
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
CreateTime string
The timestamp corresponding to the creation of this Key.
EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The resource id for the Key, which is the same as the Site Key itself.
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
createTime String
The timestamp corresponding to the creation of this Key.
effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource id for the Key, which is the same as the Site Key itself.
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
createTime string
The timestamp corresponding to the creation of this Key.
effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id string
The provider-assigned unique ID for this managed resource.
name string
The resource id for the Key, which is the same as the Site Key itself.
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
create_time str
The timestamp corresponding to the creation of this Key.
effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id str
The provider-assigned unique ID for this managed resource.
name str
The resource id for the Key, which is the same as the Site Key itself.
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
createTime String
The timestamp corresponding to the creation of this Key.
effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
id String
The provider-assigned unique ID for this managed resource.
name String
The resource id for the Key, which is the same as the Site Key itself.
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.

Look up Existing EnterpriseKey Resource

Get an existing EnterpriseKey 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?: EnterpriseKeyState, opts?: CustomResourceOptions): EnterpriseKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        android_settings: Optional[EnterpriseKeyAndroidSettingsArgs] = None,
        create_time: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        ios_settings: Optional[EnterpriseKeyIosSettingsArgs] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        testing_options: Optional[EnterpriseKeyTestingOptionsArgs] = None,
        waf_settings: Optional[EnterpriseKeyWafSettingsArgs] = None,
        web_settings: Optional[EnterpriseKeyWebSettingsArgs] = None) -> EnterpriseKey
func GetEnterpriseKey(ctx *Context, name string, id IDInput, state *EnterpriseKeyState, opts ...ResourceOption) (*EnterpriseKey, error)
public static EnterpriseKey Get(string name, Input<string> id, EnterpriseKeyState? state, CustomResourceOptions? opts = null)
public static EnterpriseKey get(String name, Output<String> id, EnterpriseKeyState state, CustomResourceOptions options)
resources:  _:    type: gcp:recaptcha:EnterpriseKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AndroidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
CreateTime string
The timestamp corresponding to the creation of this Key.
DisplayName string
Human-readable display name of this key. Modifiable by user.

EffectiveLabels Dictionary<string, string>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
IosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
Labels Dictionary<string, string>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name string
The resource id for the Key, which is the same as the Site Key itself.
Project Changes to this property will trigger replacement. string
The project for the resource
PulumiLabels Dictionary<string, string>
The combination of labels configured directly on the resource and default labels configured on the provider.
TestingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
WafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
WebSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
AndroidSettings EnterpriseKeyAndroidSettingsArgs
Settings for keys that can be used by Android apps.
CreateTime string
The timestamp corresponding to the creation of this Key.
DisplayName string
Human-readable display name of this key. Modifiable by user.

EffectiveLabels map[string]string
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
IosSettings EnterpriseKeyIosSettingsArgs
Settings for keys that can be used by iOS apps.
Labels map[string]string

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

Name string
The resource id for the Key, which is the same as the Site Key itself.
Project Changes to this property will trigger replacement. string
The project for the resource
PulumiLabels map[string]string
The combination of labels configured directly on the resource and default labels configured on the provider.
TestingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptionsArgs
Options for user acceptance testing.
WafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettingsArgs
Settings specific to keys that can be used for WAF (Web Application Firewall).
WebSettings EnterpriseKeyWebSettingsArgs
Settings for keys that can be used by websites.
androidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
createTime String
The timestamp corresponding to the creation of this Key.
displayName String
Human-readable display name of this key. Modifiable by user.

effectiveLabels Map<String,String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
iosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
labels Map<String,String>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name String
The resource id for the Key, which is the same as the Site Key itself.
project Changes to this property will trigger replacement. String
The project for the resource
pulumiLabels Map<String,String>
The combination of labels configured directly on the resource and default labels configured on the provider.
testingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
androidSettings EnterpriseKeyAndroidSettings
Settings for keys that can be used by Android apps.
createTime string
The timestamp corresponding to the creation of this Key.
displayName string
Human-readable display name of this key. Modifiable by user.

effectiveLabels {[key: string]: string}
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
iosSettings EnterpriseKeyIosSettings
Settings for keys that can be used by iOS apps.
labels {[key: string]: string}

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name string
The resource id for the Key, which is the same as the Site Key itself.
project Changes to this property will trigger replacement. string
The project for the resource
pulumiLabels {[key: string]: string}
The combination of labels configured directly on the resource and default labels configured on the provider.
testingOptions Changes to this property will trigger replacement. EnterpriseKeyTestingOptions
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. EnterpriseKeyWafSettings
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings EnterpriseKeyWebSettings
Settings for keys that can be used by websites.
android_settings EnterpriseKeyAndroidSettingsArgs
Settings for keys that can be used by Android apps.
create_time str
The timestamp corresponding to the creation of this Key.
display_name str
Human-readable display name of this key. Modifiable by user.

effective_labels Mapping[str, str]
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
ios_settings EnterpriseKeyIosSettingsArgs
Settings for keys that can be used by iOS apps.
labels Mapping[str, str]

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name str
The resource id for the Key, which is the same as the Site Key itself.
project Changes to this property will trigger replacement. str
The project for the resource
pulumi_labels Mapping[str, str]
The combination of labels configured directly on the resource and default labels configured on the provider.
testing_options Changes to this property will trigger replacement. EnterpriseKeyTestingOptionsArgs
Options for user acceptance testing.
waf_settings Changes to this property will trigger replacement. EnterpriseKeyWafSettingsArgs
Settings specific to keys that can be used for WAF (Web Application Firewall).
web_settings EnterpriseKeyWebSettingsArgs
Settings for keys that can be used by websites.
androidSettings Property Map
Settings for keys that can be used by Android apps.
createTime String
The timestamp corresponding to the creation of this Key.
displayName String
Human-readable display name of this key. Modifiable by user.

effectiveLabels Map<String>
All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
iosSettings Property Map
Settings for keys that can be used by iOS apps.
labels Map<String>

See Creating and managing labels.

Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

name String
The resource id for the Key, which is the same as the Site Key itself.
project Changes to this property will trigger replacement. String
The project for the resource
pulumiLabels Map<String>
The combination of labels configured directly on the resource and default labels configured on the provider.
testingOptions Changes to this property will trigger replacement. Property Map
Options for user acceptance testing.
wafSettings Changes to this property will trigger replacement. Property Map
Settings specific to keys that can be used for WAF (Web Application Firewall).
webSettings Property Map
Settings for keys that can be used by websites.

Supporting Types

EnterpriseKeyAndroidSettings
, EnterpriseKeyAndroidSettingsArgs

AllowAllPackageNames bool
If set to true, it means allowed_package_names will not be enforced.
AllowedPackageNames List<string>
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
AllowAllPackageNames bool
If set to true, it means allowed_package_names will not be enforced.
AllowedPackageNames []string
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
allowAllPackageNames Boolean
If set to true, it means allowed_package_names will not be enforced.
allowedPackageNames List<String>
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
allowAllPackageNames boolean
If set to true, it means allowed_package_names will not be enforced.
allowedPackageNames string[]
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
allow_all_package_names bool
If set to true, it means allowed_package_names will not be enforced.
allowed_package_names Sequence[str]
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'
allowAllPackageNames Boolean
If set to true, it means allowed_package_names will not be enforced.
allowedPackageNames List<String>
Android package names of apps allowed to use the key. Example: 'com.companyname.appname'

EnterpriseKeyIosSettings
, EnterpriseKeyIosSettingsArgs

AllowAllBundleIds bool
If set to true, it means allowed_bundle_ids will not be enforced.
AllowedBundleIds List<string>
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
AllowAllBundleIds bool
If set to true, it means allowed_bundle_ids will not be enforced.
AllowedBundleIds []string
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
allowAllBundleIds Boolean
If set to true, it means allowed_bundle_ids will not be enforced.
allowedBundleIds List<String>
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
allowAllBundleIds boolean
If set to true, it means allowed_bundle_ids will not be enforced.
allowedBundleIds string[]
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
allow_all_bundle_ids bool
If set to true, it means allowed_bundle_ids will not be enforced.
allowed_bundle_ids Sequence[str]
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'
allowAllBundleIds Boolean
If set to true, it means allowed_bundle_ids will not be enforced.
allowedBundleIds List<String>
iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname'

EnterpriseKeyTestingOptions
, EnterpriseKeyTestingOptionsArgs

TestingChallenge Changes to this property will trigger replacement. string
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
TestingScore Changes to this property will trigger replacement. double
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
TestingChallenge Changes to this property will trigger replacement. string
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
TestingScore Changes to this property will trigger replacement. float64
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
testingChallenge Changes to this property will trigger replacement. String
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
testingScore Changes to this property will trigger replacement. Double
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
testingChallenge Changes to this property will trigger replacement. string
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
testingScore Changes to this property will trigger replacement. number
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
testing_challenge Changes to this property will trigger replacement. str
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
testing_score Changes to this property will trigger replacement. float
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.
testingChallenge Changes to this property will trigger replacement. String
For challenge-based keys only (CHECKBOX, INVISIBLE), all challenge requests for this site will return nocaptcha if NOCAPTCHA, or an unsolvable challenge if UNSOLVABLE_CHALLENGE. Possible values: TESTING_CHALLENGE_UNSPECIFIED, NOCAPTCHA, UNSOLVABLE_CHALLENGE
testingScore Changes to this property will trigger replacement. Number
All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

EnterpriseKeyWafSettings
, EnterpriseKeyWafSettingsArgs

WafFeature
This property is required.
Changes to this property will trigger replacement.
string
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
WafService
This property is required.
Changes to this property will trigger replacement.
string
The WAF service that uses this key. Possible values: CA, FASTLY
WafFeature
This property is required.
Changes to this property will trigger replacement.
string
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
WafService
This property is required.
Changes to this property will trigger replacement.
string
The WAF service that uses this key. Possible values: CA, FASTLY
wafFeature
This property is required.
Changes to this property will trigger replacement.
String
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
wafService
This property is required.
Changes to this property will trigger replacement.
String
The WAF service that uses this key. Possible values: CA, FASTLY
wafFeature
This property is required.
Changes to this property will trigger replacement.
string
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
wafService
This property is required.
Changes to this property will trigger replacement.
string
The WAF service that uses this key. Possible values: CA, FASTLY
waf_feature
This property is required.
Changes to this property will trigger replacement.
str
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
waf_service
This property is required.
Changes to this property will trigger replacement.
str
The WAF service that uses this key. Possible values: CA, FASTLY
wafFeature
This property is required.
Changes to this property will trigger replacement.
String
Supported WAF features. For more information, see https://cloud.google.com/recaptcha-enterprise/docs/usecase#comparison_of_features. Possible values: CHALLENGE_PAGE, SESSION_TOKEN, ACTION_TOKEN, EXPRESS
wafService
This property is required.
Changes to this property will trigger replacement.
String
The WAF service that uses this key. Possible values: CA, FASTLY

EnterpriseKeyWebSettings
, EnterpriseKeyWebSettingsArgs

IntegrationType
This property is required.
Changes to this property will trigger replacement.
string
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
AllowAllDomains bool
If set to true, it means allowed_domains will not be enforced.
AllowAmpTraffic bool
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
AllowedDomains List<string>
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
ChallengeSecurityPreference string
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
IntegrationType
This property is required.
Changes to this property will trigger replacement.
string
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
AllowAllDomains bool
If set to true, it means allowed_domains will not be enforced.
AllowAmpTraffic bool
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
AllowedDomains []string
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
ChallengeSecurityPreference string
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
integrationType
This property is required.
Changes to this property will trigger replacement.
String
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
allowAllDomains Boolean
If set to true, it means allowed_domains will not be enforced.
allowAmpTraffic Boolean
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
allowedDomains List<String>
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
challengeSecurityPreference String
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
integrationType
This property is required.
Changes to this property will trigger replacement.
string
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
allowAllDomains boolean
If set to true, it means allowed_domains will not be enforced.
allowAmpTraffic boolean
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
allowedDomains string[]
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
challengeSecurityPreference string
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
integration_type
This property is required.
Changes to this property will trigger replacement.
str
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
allow_all_domains bool
If set to true, it means allowed_domains will not be enforced.
allow_amp_traffic bool
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
allowed_domains Sequence[str]
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
challenge_security_preference str
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY
integrationType
This property is required.
Changes to this property will trigger replacement.
String
Required. Describes how this key is integrated with the website. Possible values: SCORE, CHECKBOX, INVISIBLE
allowAllDomains Boolean
If set to true, it means allowed_domains will not be enforced.
allowAmpTraffic Boolean
If set to true, the key can be used on AMP (Accelerated Mobile Pages) websites. This is supported only for the SCORE integration type.
allowedDomains List<String>
Domains or subdomains of websites allowed to use the key. All subdomains of an allowed domain are automatically allowed. A valid domain requires a host and must not include any path, port, query or fragment. Examples: 'example.com' or 'subdomain.example.com'
challengeSecurityPreference String
Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for IntegrationTypes CHECKBOX and INVISIBLE. Possible values: CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED, USABILITY, BALANCE, SECURITY

Import

Key can be imported using any of these accepted formats:

  • projects/{{project}}/keys/{{name}}

  • {{project}}/{{name}}

  • {{name}}

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

$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default projects/{{project}}/keys/{{name}}
Copy
$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{project}}/{{name}}
Copy
$ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{name}}
Copy

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.
Google Cloud v8.25.0 published on Thursday, Apr 3, 2025 by Pulumi
pulumi/pulumi-gcp