1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. recaptcha
  5. EnterpriseKey
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi

gcp.recaptcha.EnterpriseKey

Explore with Pulumi AI

gcp logo
Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi

    The RecaptchaEnterprise Key resource

    Example Usage

    Android_key

    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()
        {
            AndroidSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyAndroidSettingsArgs
            {
                AllowAllPackageNames = true,
                AllowedPackageNames = new[] {},
            },
            DisplayName = "display-name-one",
            Labels = 
            {
                { "label-one", "value-one" },
            },
            Project = "my-project-name",
            TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
            {
                TestingScore = 0.8,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/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{
    			AndroidSettings: &recaptcha.EnterpriseKeyAndroidSettingsArgs{
    				AllowAllPackageNames: pulumi.Bool(true),
    				AllowedPackageNames:  pulumi.StringArray{},
    			},
    			DisplayName: pulumi.String("display-name-one"),
    			Labels: pulumi.StringMap{
    				"label-one": pulumi.String("value-one"),
    			},
    			Project: pulumi.String("my-project-name"),
    			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
    				TestingScore: pulumi.Float64(0.8),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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()        
                .androidSettings(EnterpriseKeyAndroidSettingsArgs.builder()
                    .allowAllPackageNames(true)
                    .allowedPackageNames()
                    .build())
                .displayName("display-name-one")
                .labels(Map.of("label-one", "value-one"))
                .project("my-project-name")
                .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                    .testingScore(0.8)
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.recaptcha.EnterpriseKey("primary",
        android_settings=gcp.recaptcha.EnterpriseKeyAndroidSettingsArgs(
            allow_all_package_names=True,
            allowed_package_names=[],
        ),
        display_name="display-name-one",
        labels={
            "label-one": "value-one",
        },
        project="my-project-name",
        testing_options=gcp.recaptcha.EnterpriseKeyTestingOptionsArgs(
            testing_score=0.8,
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.recaptcha.EnterpriseKey("primary", {
        androidSettings: {
            allowAllPackageNames: true,
            allowedPackageNames: [],
        },
        displayName: "display-name-one",
        labels: {
            "label-one": "value-one",
        },
        project: "my-project-name",
        testingOptions: {
            testingScore: 0.8,
        },
    });
    
    resources:
      primary:
        type: gcp:recaptcha:EnterpriseKey
        properties:
          androidSettings:
            allowAllPackageNames: true
            allowedPackageNames: []
          displayName: display-name-one
          labels:
            label-one: value-one
          project: my-project-name
          testingOptions:
            testingScore: 0.8
    

    Ios_key

    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[] {},
            },
            Labels = 
            {
                { "label-one", "value-one" },
            },
            Project = "my-project-name",
            TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
            {
                TestingScore = 1,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/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{},
    			},
    			Labels: pulumi.StringMap{
    				"label-one": pulumi.String("value-one"),
    			},
    			Project: pulumi.String("my-project-name"),
    			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
    				TestingScore: pulumi.Float64(1),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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())
                .labels(Map.of("label-one", "value-one"))
                .project("my-project-name")
                .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                    .testingScore(1)
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.recaptcha.EnterpriseKey("primary",
        display_name="display-name-one",
        ios_settings=gcp.recaptcha.EnterpriseKeyIosSettingsArgs(
            allow_all_bundle_ids=True,
            allowed_bundle_ids=[],
        ),
        labels={
            "label-one": "value-one",
        },
        project="my-project-name",
        testing_options=gcp.recaptcha.EnterpriseKeyTestingOptionsArgs(
            testing_score=1,
        ))
    
    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: [],
        },
        labels: {
            "label-one": "value-one",
        },
        project: "my-project-name",
        testingOptions: {
            testingScore: 1,
        },
    });
    
    resources:
      primary:
        type: gcp:recaptcha:EnterpriseKey
        properties:
          displayName: display-name-one
          iosSettings:
            allowAllBundleIds: true
            allowedBundleIds: []
          labels:
            label-one: value-one
          project: my-project-name
          testingOptions:
            testingScore: 1
    

    Minimal_key

    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",
            Labels = null,
            Project = "my-project-name",
            WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
            {
                AllowAllDomains = true,
                IntegrationType = "SCORE",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/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"),
    			Labels:      nil,
    			Project:     pulumi.String("my-project-name"),
    			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
    				AllowAllDomains: pulumi.Bool(true),
    				IntegrationType: pulumi.String("SCORE"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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")
                .labels()
                .project("my-project-name")
                .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                    .allowAllDomains(true)
                    .integrationType("SCORE")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.recaptcha.EnterpriseKey("primary",
        display_name="display-name-one",
        labels={},
        project="my-project-name",
        web_settings=gcp.recaptcha.EnterpriseKeyWebSettingsArgs(
            allow_all_domains=True,
            integration_type="SCORE",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.recaptcha.EnterpriseKey("primary", {
        displayName: "display-name-one",
        labels: {},
        project: "my-project-name",
        webSettings: {
            allowAllDomains: true,
            integrationType: "SCORE",
        },
    });
    
    resources:
      primary:
        type: gcp:recaptcha:EnterpriseKey
        properties:
          displayName: display-name-one
          labels: {}
          project: my-project-name
          webSettings:
            allowAllDomains: true
            integrationType: SCORE
    

    Web_key

    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",
            Labels = 
            {
                { "label-one", "value-one" },
            },
            Project = "my-project-name",
            TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
            {
                TestingChallenge = "NOCAPTCHA",
                TestingScore = 0.5,
            },
            WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
            {
                AllowAllDomains = true,
                AllowedDomains = new[] {},
                ChallengeSecurityPreference = "USABILITY",
                IntegrationType = "CHECKBOX",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/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"),
    			Labels: pulumi.StringMap{
    				"label-one": pulumi.String("value-one"),
    			},
    			Project: pulumi.String("my-project-name"),
    			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
    				TestingChallenge: pulumi.String("NOCAPTCHA"),
    				TestingScore:     pulumi.Float64(0.5),
    			},
    			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
    				AllowAllDomains:             pulumi.Bool(true),
    				AllowedDomains:              pulumi.StringArray{},
    				ChallengeSecurityPreference: pulumi.String("USABILITY"),
    				IntegrationType:             pulumi.String("CHECKBOX"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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")
                .labels(Map.of("label-one", "value-one"))
                .project("my-project-name")
                .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                    .testingChallenge("NOCAPTCHA")
                    .testingScore(0.5)
                    .build())
                .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                    .allowAllDomains(true)
                    .allowedDomains()
                    .challengeSecurityPreference("USABILITY")
                    .integrationType("CHECKBOX")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.recaptcha.EnterpriseKey("primary",
        display_name="display-name-one",
        labels={
            "label-one": "value-one",
        },
        project="my-project-name",
        testing_options=gcp.recaptcha.EnterpriseKeyTestingOptionsArgs(
            testing_challenge="NOCAPTCHA",
            testing_score=0.5,
        ),
        web_settings=gcp.recaptcha.EnterpriseKeyWebSettingsArgs(
            allow_all_domains=True,
            allowed_domains=[],
            challenge_security_preference="USABILITY",
            integration_type="CHECKBOX",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.recaptcha.EnterpriseKey("primary", {
        displayName: "display-name-one",
        labels: {
            "label-one": "value-one",
        },
        project: "my-project-name",
        testingOptions: {
            testingChallenge: "NOCAPTCHA",
            testingScore: 0.5,
        },
        webSettings: {
            allowAllDomains: true,
            allowedDomains: [],
            challengeSecurityPreference: "USABILITY",
            integrationType: "CHECKBOX",
        },
    });
    
    resources:
      primary:
        type: gcp:recaptcha:EnterpriseKey
        properties:
          displayName: display-name-one
          labels:
            label-one: value-one
          project: my-project-name
          testingOptions:
            testingChallenge: NOCAPTCHA
            testingScore: 0.5
          webSettings:
            allowAllDomains: true
            allowedDomains: []
            challengeSecurityPreference: USABILITY
            integrationType: CHECKBOX
    

    Web_score_key

    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",
            Labels = 
            {
                { "label-one", "value-one" },
            },
            Project = "my-project-name",
            TestingOptions = new Gcp.Recaptcha.Inputs.EnterpriseKeyTestingOptionsArgs
            {
                TestingScore = 0.5,
            },
            WebSettings = new Gcp.Recaptcha.Inputs.EnterpriseKeyWebSettingsArgs
            {
                AllowAllDomains = true,
                AllowAmpTraffic = false,
                AllowedDomains = new[] {},
                IntegrationType = "SCORE",
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-gcp/sdk/v6/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"),
    			Labels: pulumi.StringMap{
    				"label-one": pulumi.String("value-one"),
    			},
    			Project: pulumi.String("my-project-name"),
    			TestingOptions: &recaptcha.EnterpriseKeyTestingOptionsArgs{
    				TestingScore: pulumi.Float64(0.5),
    			},
    			WebSettings: &recaptcha.EnterpriseKeyWebSettingsArgs{
    				AllowAllDomains: pulumi.Bool(true),
    				AllowAmpTraffic: pulumi.Bool(false),
    				AllowedDomains:  pulumi.StringArray{},
    				IntegrationType: pulumi.String("SCORE"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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")
                .labels(Map.of("label-one", "value-one"))
                .project("my-project-name")
                .testingOptions(EnterpriseKeyTestingOptionsArgs.builder()
                    .testingScore(0.5)
                    .build())
                .webSettings(EnterpriseKeyWebSettingsArgs.builder()
                    .allowAllDomains(true)
                    .allowAmpTraffic(false)
                    .allowedDomains()
                    .integrationType("SCORE")
                    .build())
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_gcp as gcp
    
    primary = gcp.recaptcha.EnterpriseKey("primary",
        display_name="display-name-one",
        labels={
            "label-one": "value-one",
        },
        project="my-project-name",
        testing_options=gcp.recaptcha.EnterpriseKeyTestingOptionsArgs(
            testing_score=0.5,
        ),
        web_settings=gcp.recaptcha.EnterpriseKeyWebSettingsArgs(
            allow_all_domains=True,
            allow_amp_traffic=False,
            allowed_domains=[],
            integration_type="SCORE",
        ))
    
    import * as pulumi from "@pulumi/pulumi";
    import * as gcp from "@pulumi/gcp";
    
    const primary = new gcp.recaptcha.EnterpriseKey("primary", {
        displayName: "display-name-one",
        labels: {
            "label-one": "value-one",
        },
        project: "my-project-name",
        testingOptions: {
            testingScore: 0.5,
        },
        webSettings: {
            allowAllDomains: true,
            allowAmpTraffic: false,
            allowedDomains: [],
            integrationType: "SCORE",
        },
    });
    
    resources:
      primary:
        type: gcp:recaptcha:EnterpriseKey
        properties:
          displayName: display-name-one
          labels:
            label-one: value-one
          project: my-project-name
          testingOptions:
            testingScore: 0.5
          webSettings:
            allowAllDomains: true
            allowAmpTraffic: false
            allowedDomains: []
            integrationType: SCORE
    

    Create EnterpriseKey Resource

    new EnterpriseKey(name: string, args: EnterpriseKeyArgs, opts?: CustomResourceOptions);
    @overload
    def EnterpriseKey(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      android_settings: Optional[EnterpriseKeyAndroidSettingsArgs] = None,
                      display_name: Optional[str] = None,
                      ios_settings: Optional[EnterpriseKeyIosSettingsArgs] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      project: Optional[str] = None,
                      testing_options: Optional[EnterpriseKeyTestingOptionsArgs] = None,
                      web_settings: Optional[EnterpriseKeyWebSettingsArgs] = None)
    @overload
    def EnterpriseKey(resource_name: str,
                      args: EnterpriseKeyArgs,
                      opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args EnterpriseKeyArgs
    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 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 string
    The unique name of the resource.
    args EnterpriseKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnterpriseKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnterpriseKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The EnterpriseKey resource accepts the following input properties:

    DisplayName 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.

    Project string

    The project for the resource

    TestingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    WebSettings EnterpriseKeyWebSettings

    Settings for keys that can be used by websites.

    DisplayName 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.

    Project string

    The project for the resource

    TestingOptions EnterpriseKeyTestingOptionsArgs

    Options for user acceptance testing.

    WebSettings EnterpriseKeyWebSettingsArgs

    Settings for keys that can be used by websites.

    displayName 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.

    project String

    The project for the resource

    testingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    webSettings EnterpriseKeyWebSettings

    Settings for keys that can be used by websites.

    displayName 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.

    project string

    The project for the resource

    testingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    webSettings EnterpriseKeyWebSettings

    Settings for keys that can be used by websites.

    display_name 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.

    project str

    The project for the resource

    testing_options EnterpriseKeyTestingOptionsArgs

    Options for user acceptance testing.

    web_settings EnterpriseKeyWebSettingsArgs

    Settings for keys that can be used by websites.

    displayName 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.

    project String

    The project for the resource

    testingOptions Property Map

    Options for user acceptance testing.

    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.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    CreateTime string

    The timestamp corresponding to the creation of this Key.

    Id string

    The provider-assigned unique ID for this managed resource.

    Name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    createTime String

    The timestamp corresponding to the creation of this Key.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    createTime string

    The timestamp corresponding to the creation of this Key.

    id string

    The provider-assigned unique ID for this managed resource.

    name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    create_time str

    The timestamp corresponding to the creation of this Key.

    id str

    The provider-assigned unique ID for this managed resource.

    name str

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    createTime String

    The timestamp corresponding to the creation of this Key.

    id String

    The provider-assigned unique ID for this managed resource.

    name String

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    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,
            ios_settings: Optional[EnterpriseKeyIosSettingsArgs] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            testing_options: Optional[EnterpriseKeyTestingOptionsArgs] = 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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.


    IosSettings EnterpriseKeyIosSettings

    Settings for keys that can be used by iOS apps.

    Labels Dictionary<string, string>

    See Creating and managing labels.

    Name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    Project string

    The project for the resource

    TestingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    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.


    IosSettings EnterpriseKeyIosSettingsArgs

    Settings for keys that can be used by iOS apps.

    Labels map[string]string

    See Creating and managing labels.

    Name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    Project string

    The project for the resource

    TestingOptions EnterpriseKeyTestingOptionsArgs

    Options for user acceptance testing.

    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.


    iosSettings EnterpriseKeyIosSettings

    Settings for keys that can be used by iOS apps.

    labels Map<String,String>

    See Creating and managing labels.

    name String

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    project String

    The project for the resource

    testingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    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.


    iosSettings EnterpriseKeyIosSettings

    Settings for keys that can be used by iOS apps.

    labels {[key: string]: string}

    See Creating and managing labels.

    name string

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    project string

    The project for the resource

    testingOptions EnterpriseKeyTestingOptions

    Options for user acceptance testing.

    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.


    ios_settings EnterpriseKeyIosSettingsArgs

    Settings for keys that can be used by iOS apps.

    labels Mapping[str, str]

    See Creating and managing labels.

    name str

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    project str

    The project for the resource

    testing_options EnterpriseKeyTestingOptionsArgs

    Options for user acceptance testing.

    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.


    iosSettings Property Map

    Settings for keys that can be used by iOS apps.

    labels Map<String>

    See Creating and managing labels.

    name String

    The resource name for the Key in the format "projects/{project}/keys/{key}".

    project String

    The project for the resource

    testingOptions Property Map

    Options for user acceptance testing.

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

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    TestingChallenge 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 float64

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    testingChallenge 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 Double

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    testingChallenge 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 number

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    testing_challenge 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 float

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    testingChallenge 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 Number

    All assessments for this Key will return this score. Must be between 0 (likely not legitimate) and 1 (likely legitimate) inclusive.

    EnterpriseKeyWebSettings, EnterpriseKeyWebSettingsArgs

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

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the google-beta Terraform Provider.

    gcp logo
    Google Cloud Classic v6.66.0 published on Monday, Sep 18, 2023 by Pulumi