com.pulumi.cloudflare.kotlin.TurnstileWidget.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-cloudflare-kotlin Show documentation
Show all versions of pulumi-cloudflare-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.cloudflare.kotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
/**
* Builder for [TurnstileWidget].
*/
@PulumiTagMarker
public class TurnstileWidgetResourceBuilder internal constructor() {
public var name: String? = null
public var args: TurnstileWidgetArgs = TurnstileWidgetArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend TurnstileWidgetArgsBuilder.() -> Unit) {
val builder = TurnstileWidgetArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): TurnstileWidget {
val builtJavaResource = com.pulumi.cloudflare.TurnstileWidget(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return TurnstileWidget(builtJavaResource)
}
}
/**
* The [Turnstile Widget](https://developers.cloudflare.com/turnstile/) resource allows you to manage Cloudflare Turnstile Widgets.
* ## Example Usage
*
* ```typescript
* 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.com"],
* mode: "invisible",
* region: "world",
* });
* ```
* ```python
* import pulumi
* import pulumi_cloudflare as cloudflare
* example = cloudflare.TurnstileWidget("example",
* account_id="f037e56e89293a057740de681ac9abbe",
* name="example widget",
* bot_fight_mode=False,
* domains=["example.com"],
* mode="invisible",
* region="world")
* ```
* ```csharp
* 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",
* });
* });
* ```
* ```go
* 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
* })
* }
* ```
* ```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")
* .name("example widget")
* .botFightMode(false)
* .domains("example.com")
* .mode("invisible")
* .region("world")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: cloudflare:TurnstileWidget
* properties:
* accountId: f037e56e89293a057740de681ac9abbe
* name: example widget
* botFightMode: false
* domains:
* - example.com
* mode: invisible
* region: world
* ```
*
* ## Import
* ```sh
* $ pulumi import cloudflare:index/turnstileWidget:TurnstileWidget example /
* ```
*/
public class TurnstileWidget internal constructor(
override val javaResource: com.pulumi.cloudflare.TurnstileWidget,
) : KotlinCustomResource(javaResource, TurnstileWidgetMapper) {
/**
* The account identifier to target for the resource.
*/
public val accountId: Output
get() = javaResource.accountId().applyValue({ args0 -> args0 })
/**
* If bot*fight*mode is set to true, Cloudflare issues computationally expensive challenges in response to malicious bots (Enterprise only).
*/
public val botFightMode: Output
get() = javaResource.botFightMode().applyValue({ args0 -> args0 })
/**
* Domains where the widget is deployed
*/
public val domains: Output>
get() = javaResource.domains().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* Widget Mode. Available values: `non-interactive`, `invisible`, `managed`
*/
public val mode: Output
get() = javaResource.mode().applyValue({ args0 -> args0 })
/**
* Human readable widget name.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Do not show any Cloudflare branding on the widget (Enterprise only).
*/
public val offlabel: Output
get() = javaResource.offlabel().applyValue({ args0 -> args0 })
/**
* Region where this widget can be used.
*/
public val region: Output
get() = javaResource.region().applyValue({ args0 -> args0 })
/**
* Secret key for this widget.
*/
public val secret: Output
get() = javaResource.secret().applyValue({ args0 -> args0 })
}
public object TurnstileWidgetMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.cloudflare.TurnstileWidget::class == javaResource::class
override fun map(javaResource: Resource): TurnstileWidget = TurnstileWidget(
javaResource as
com.pulumi.cloudflare.TurnstileWidget,
)
}
/**
* @see [TurnstileWidget].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [TurnstileWidget].
*/
public suspend fun turnstileWidget(
name: String,
block: suspend TurnstileWidgetResourceBuilder.() -> Unit,
): TurnstileWidget {
val builder = TurnstileWidgetResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [TurnstileWidget].
* @param name The _unique_ name of the resulting resource.
*/
public fun turnstileWidget(name: String): TurnstileWidget {
val builder = TurnstileWidgetResourceBuilder()
builder.name(name)
return builder.build()
}