@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
239 lines • 8.21 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.EnterpriseKey = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("../utilities");
/**
* The RecaptchaEnterprise Key resource
*
* ## Example Usage
*
* ### Android_key
* A basic test of recaptcha enterprise key that can be used by Android apps
* ```typescript
* 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",
* },
* });
* ```
* ### Ios_key
* A basic test of recaptcha enterprise key that can be used by iOS apps
* ```typescript
* 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",
* },
* });
* ```
* ### Minimal_key
* A minimal test of recaptcha enterprise key
* ```typescript
* 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: {},
* });
* ```
* ### Waf_key
* A basic test of recaptcha enterprise key that includes WAF settings
* ```typescript
* 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",
* },
* });
* ```
* ### Web_key
* A basic test of recaptcha enterprise key that can be used by websites
* ```typescript
* 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",
* },
* });
* ```
* ### Web_score_key
* A basic test of recaptcha enterprise key with score integration type that can be used by websites
* ```typescript
* 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",
* },
* });
* ```
*
* ## 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:
*
* ```sh
* $ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default projects/{{project}}/keys/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:recaptcha/enterpriseKey:EnterpriseKey default {{name}}
* ```
*/
class EnterpriseKey extends pulumi.CustomResource {
/**
* Get an existing EnterpriseKey resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name, id, state, opts) {
return new EnterpriseKey(name, state, { ...opts, id: id });
}
/**
* Returns true if the given object is an instance of EnterpriseKey. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === EnterpriseKey.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["androidSettings"] = state?.androidSettings;
resourceInputs["createTime"] = state?.createTime;
resourceInputs["displayName"] = state?.displayName;
resourceInputs["effectiveLabels"] = state?.effectiveLabels;
resourceInputs["iosSettings"] = state?.iosSettings;
resourceInputs["labels"] = state?.labels;
resourceInputs["name"] = state?.name;
resourceInputs["project"] = state?.project;
resourceInputs["pulumiLabels"] = state?.pulumiLabels;
resourceInputs["testingOptions"] = state?.testingOptions;
resourceInputs["wafSettings"] = state?.wafSettings;
resourceInputs["webSettings"] = state?.webSettings;
}
else {
const args = argsOrState;
if (args?.displayName === undefined && !opts.urn) {
throw new Error("Missing required property 'displayName'");
}
resourceInputs["androidSettings"] = args?.androidSettings;
resourceInputs["displayName"] = args?.displayName;
resourceInputs["iosSettings"] = args?.iosSettings;
resourceInputs["labels"] = args?.labels;
resourceInputs["project"] = args?.project;
resourceInputs["testingOptions"] = args?.testingOptions;
resourceInputs["wafSettings"] = args?.wafSettings;
resourceInputs["webSettings"] = args?.webSettings;
resourceInputs["createTime"] = undefined /*out*/;
resourceInputs["effectiveLabels"] = undefined /*out*/;
resourceInputs["name"] = undefined /*out*/;
resourceInputs["pulumiLabels"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const secretOpts = { additionalSecretOutputs: ["effectiveLabels", "pulumiLabels"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(EnterpriseKey.__pulumiType, name, resourceInputs, opts);
}
}
exports.EnterpriseKey = EnterpriseKey;
/** @internal */
EnterpriseKey.__pulumiType = 'gcp:recaptcha/enterpriseKey:EnterpriseKey';
//# sourceMappingURL=enterpriseKey.js.map