Package com.pulumi.cloudflare

Class TurnstileWidget

  • public class TurnstileWidget
extends com.pulumi.resources.CustomResource
    The [Turnstile Widget](https://developers.cloudflare.com/turnstile/) resource allows you to manage Cloudflare Turnstile Widgets. ## Example Usage ```java 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") .botFightMode(false) .domains("example.com") .mode("invisible") .name("example widget") .region("world") .build()); } } ``` ## Import ```sh $ pulumi import cloudflare:index/turnstileWidget:TurnstileWidget example <account_id>/<site_key> ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> accountId()  
      com.pulumi.core.Output<java.lang.Boolean> botFightMode()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> domains()  
      static TurnstileWidget get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, TurnstileWidgetState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> mode()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.Boolean> offlabel()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> secret()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • TurnstileWidget

        public TurnstileWidget​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • TurnstileWidget

        public TurnstileWidget​(java.lang.String name,
                       TurnstileWidgetArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • TurnstileWidget

        public TurnstileWidget​(java.lang.String name,
                       TurnstileWidgetArgs args,
                       @Nullable
                       com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • accountId

        public com.pulumi.core.Output<java.lang.String> accountId()
        Returns:
        The account identifier to target for the resource.

      • botFightMode

        public com.pulumi.core.Output<java.lang.Boolean> botFightMode()
        Returns:
        If bot*fight*mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (Enterprise only).

      • domains

        public com.pulumi.core.Output<java.util.List<java.lang.String>> domains()
        Returns:
        Domains where the widget is deployed

      • mode

        public com.pulumi.core.Output<java.lang.String> mode()
        Returns:
        Widget Mode. Available values: `non-interactive`, `invisible`, `managed`

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Human readable widget name.

      • offlabel

        public com.pulumi.core.Output<java.lang.Boolean> offlabel()
        Returns:
        Do not show any Cloudflare branding on the widget (Enterprise only).

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this widget can be used.

      • secret

        public com.pulumi.core.Output<java.lang.String> secret()
        Returns:
        Secret key for this widget.

      • get

        public static TurnstileWidget get​(java.lang.String name,
                                  com.pulumi.core.Output<java.lang.String> id,
                                  @Nullable
                                  TurnstileWidgetState state,
                                  @Nullable
                                  com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.