pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/TurnstileWidgetArgs

TurnstileWidgetArgs

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleTurnstileWidget = new cloudflare.TurnstileWidget("example_turnstile_widget", {
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    domains: [
        "203.0.113.1",
        "cloudflare.com",
        "blog.example.com",
    ],
    mode: "non-interactive",
    name: "blog.cloudflare.com login form",
    botFightMode: false,
    clearanceLevel: "no_clearance",
    ephemeralId: false,
    offlabel: false,
    region: "world",
});
Content copied to clipboard
import pulumi
import pulumi_cloudflare as cloudflare
example_turnstile_widget = cloudflare.TurnstileWidget("example_turnstile_widget",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    domains=[
        "203.0.113.1",
        "cloudflare.com",
        "blog.example.com",
    ],
    mode="non-interactive",
    name="blog.cloudflare.com login form",
    bot_fight_mode=False,
    clearance_level="no_clearance",
    ephemeral_id=False,
    offlabel=False,
    region="world")
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
    var exampleTurnstileWidget = new Cloudflare.TurnstileWidget("example_turnstile_widget", new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        Domains = new[]
        {
            "203.0.113.1",
            "cloudflare.com",
            "blog.example.com",
        },
        Mode = "non-interactive",
        Name = "blog.cloudflare.com login form",
        BotFightMode = false,
        ClearanceLevel = "no_clearance",
        EphemeralId = false,
        Offlabel = false,
        Region = "world",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewTurnstileWidget(ctx, "example_turnstile_widget", &cloudflare.TurnstileWidgetArgs{
			AccountId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
			Domains: pulumi.StringArray{
				pulumi.String("203.0.113.1"),
				pulumi.String("cloudflare.com"),
				pulumi.String("blog.example.com"),
			},
			Mode:           pulumi.String("non-interactive"),
			Name:           pulumi.String("blog.cloudflare.com login form"),
			BotFightMode:   pulumi.Bool(false),
			ClearanceLevel: pulumi.String("no_clearance"),
			EphemeralId:    pulumi.Bool(false),
			Offlabel:       pulumi.Bool(false),
			Region:         pulumi.String("world"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
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 exampleTurnstileWidget = new TurnstileWidget("exampleTurnstileWidget", TurnstileWidgetArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .domains(
                "203.0.113.1",
                "cloudflare.com",
                "blog.example.com")
            .mode("non-interactive")
            .name("blog.cloudflare.com login form")
            .botFightMode(false)
            .clearanceLevel("no_clearance")
            .ephemeralId(false)
            .offlabel(false)
            .region("world")
            .build());
    }
}
Content copied to clipboard
resources:
  exampleTurnstileWidget:
    type: cloudflare:TurnstileWidget
    name: example_turnstile_widget
    properties:
      accountId: 023e105f4ecef8ad9ca31a8372d0c353
      domains:
        - 203.0.113.1
        - cloudflare.com
        - blog.example.com
      mode: non-interactive
      name: blog.cloudflare.com login form
      botFightMode: false
      clearanceLevel: no_clearance
      ephemeralId: false
      offlabel: false
      region: world
Content copied to clipboard

Import

$ pulumi import cloudflare:index/turnstileWidget:TurnstileWidget example '<account_id>/<sitekey>'
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(accountId: Output<String>? = null, botFightMode: Output<Boolean>? = null, clearanceLevel: Output<String>? = null, domains: Output<List<String>>? = null, ephemeralId: Output<Boolean>? = 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

Identifier

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 (ENT only).

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

If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance, this setting can determine the clearance level to be set Available values: "no_clearance", "jschallenge", "managed", "interactive".

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

Return the Ephemeral ID in /siteverify (ENT only).

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. Not unique. Cloudflare suggests that you set this to a meaningful string to make it easier to identify your widget, and where it is used.

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

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

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

Region where this widget can be used. Available values: "world".

Functions

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