com.pulumi.cloudflare.kotlin.CustomPages.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 5.47.0.0
Show newest version
@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

/**
 * Builder for [CustomPages].
 */
@PulumiTagMarker
public class CustomPagesResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: CustomPagesArgs = CustomPagesArgs()

    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 CustomPagesArgsBuilder.() -> Unit) {
        val builder = CustomPagesArgsBuilder()
        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(): CustomPages {
        val builtJavaResource = com.pulumi.cloudflare.CustomPages(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return CustomPages(builtJavaResource)
    }
}

/**
 * Provides a resource which manages Cloudflare custom error pages.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudflare from "@pulumi/cloudflare";
 * const example = new cloudflare.CustomPages("example", {
 *     zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
 *     type: "basic_challenge",
 *     url: "https://example.com/challenge.html",
 *     state: "customized",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_cloudflare as cloudflare
 * example = cloudflare.CustomPages("example",
 *     zone_id="0da42c8d2132a9ddaf714f9e7c920711",
 *     type="basic_challenge",
 *     url="https://example.com/challenge.html",
 *     state="customized")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Cloudflare = Pulumi.Cloudflare;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Cloudflare.CustomPages("example", new()
 *     {
 *         ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
 *         Type = "basic_challenge",
 *         Url = "https://example.com/challenge.html",
 *         State = "customized",
 *     });
 * });
 * ```
 * ```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.NewCustomPages(ctx, "example", &cloudflare.CustomPagesArgs{
 * 			ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
 * 			Type:   pulumi.String("basic_challenge"),
 * 			Url:    pulumi.String("https://example.com/challenge.html"),
 * 			State:  pulumi.String("customized"),
 * 		})
 * 		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.CustomPages;
 * import com.pulumi.cloudflare.CustomPagesArgs;
 * 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 CustomPages("example", CustomPagesArgs.builder()
 *             .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
 *             .type("basic_challenge")
 *             .url("https://example.com/challenge.html")
 *             .state("customized")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: cloudflare:CustomPages
 *     properties:
 *       zoneId: 0da42c8d2132a9ddaf714f9e7c920711
 *       type: basic_challenge
 *       url: https://example.com/challenge.html
 *       state: customized
 * ```
 * 
 * ## Import
 * ```sh
 * $ pulumi import cloudflare:index/customPages:CustomPages example //
 * ```
 */
public class CustomPages internal constructor(
    override val javaResource: com.pulumi.cloudflare.CustomPages,
) : KotlinCustomResource(javaResource, CustomPagesMapper) {
    /**
     * The account identifier to target for the resource. Conflicts with `zone_id`.
     */
    public val accountId: Output?
        get() = javaResource.accountId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * Managed state of the custom page. Available values: `default`, `customized`.
     */
    public val state: Output?
        get() = javaResource.state().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The type of custom page you wish to update. Available values: `basic_challenge`, `waf_challenge`, `waf_block`, `ratelimit_block`, `country_challenge`, `ip_block`, `under_attack`, `500_errors`, `1000_errors`, `managed_challenge`.
     */
    public val type: Output
        get() = javaResource.type().applyValue({ args0 -> args0 })

    /**
     * URL of where the custom page source is located.
     */
    public val url: Output
        get() = javaResource.url().applyValue({ args0 -> args0 })

    /**
     * The zone identifier to target for the resource. Conflicts with `account_id`.
     */
    public val zoneId: Output?
        get() = javaResource.zoneId().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
}

public object CustomPagesMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.cloudflare.CustomPages::class == javaResource::class

    override fun map(javaResource: Resource): CustomPages = CustomPages(
        javaResource as
            com.pulumi.cloudflare.CustomPages,
    )
}

/**
 * @see [CustomPages].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [CustomPages].
 */
public suspend fun customPages(name: String, block: suspend CustomPagesResourceBuilder.() -> Unit): CustomPages {
    val builder = CustomPagesResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [CustomPages].
 * @param name The _unique_ name of the resulting resource.
 */
public fun customPages(name: String): CustomPages {
    val builder = CustomPagesResourceBuilder()
    builder.name(name)
    return builder.build()
}