TurnstileWidgetArgs

data class TurnstileWidgetArgs(val accountId: Output<String>? = null, val botFightMode: Output<Boolean>? = null, val domains: Output<List<String>>? = null, val mode: Output<String>? = null, val name: Output<String>? = null, val offlabel: Output<Boolean>? = null, val region: Output<String>? = null) : ConvertibleToJava<TurnstileWidgetArgs>

The Turnstile Widget resource allows you to manage Cloudflare Turnstile Widgets.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const example = new cloudflare.TurnstileWidget("example", {
accountId: "f037e56e89293a057740de681ac9abbe",
name: "example widget",
botFightMode: false,
domains: ["example&#46;com"],
mode: "invisible",
region: "world",
});
import pulumi
import pulumi_cloudflare as cloudflare
example = cloudflare.TurnstileWidget("example",
account_id="f037e56e89293a057740de681ac9abbe",
name="example widget",
bot_fight_mode=False,
domains=["example&#46;com"],
mode="invisible",
region="world")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var example = new Cloudflare.TurnstileWidget("example", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
Name = "example widget",
BotFightMode = false,
Domains = new[]
{
"example.com",
},
Mode = "invisible",
Region = "world",
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewTurnstileWidget(ctx, "example", &cloudflare.TurnstileWidgetArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
Name: pulumi.String("example widget"),
BotFightMode: pulumi.Bool(false),
Domains: pulumi.StringArray{
pulumi.String("example.com"),
},
Mode: pulumi.String("invisible"),
Region: pulumi.String("world"),
})
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.cloudflare.TurnstileWidget;
import com.pulumi.cloudflare.TurnstileWidgetArgs;
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 example = new TurnstileWidget("example", TurnstileWidgetArgs.builder()
.accountId("f037e56e89293a057740de681ac9abbe")
.name("example widget")
.botFightMode(false)
.domains("example.com")
.mode("invisible")
.region("world")
.build());
}
}
resources:
example:
type: cloudflare:TurnstileWidget
properties:
accountId: f037e56e89293a057740de681ac9abbe
name: example widget
botFightMode: false
domains:
- example.com
mode: invisible
region: world

Import

$ pulumi import cloudflare:index/turnstileWidget:TurnstileWidget example <account_id>/<site_key>

Constructors

Link copied to clipboard
constructor(accountId: Output<String>? = null, botFightMode: Output<Boolean>? = null, domains: Output<List<String>>? = null, mode: Output<String>? = null, name: Output<String>? = null, offlabel: Output<Boolean>? = null, region: Output<String>? = null)

Properties

Link copied to clipboard
val accountId: Output<String>? = null

The account identifier to target for the resource.

Link copied to clipboard
val botFightMode: Output<Boolean>? = null

If botfightmode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (Enterprise only).

Link copied to clipboard
val domains: Output<List<String>>? = null

Domains where the widget is deployed

Link copied to clipboard
val mode: Output<String>? = null

Widget Mode. Available values: non-interactive, invisible, managed

Link copied to clipboard
val name: Output<String>? = null

Human readable widget name.

Link copied to clipboard
val offlabel: Output<Boolean>? = null

Do not show any Cloudflare branding on the widget (Enterprise only).

Link copied to clipboard
val region: Output<String>? = null

Region where this widget can be used.

Functions

Link copied to clipboard
open override fun toJava(): TurnstileWidgetArgs