com.pulumi.cloudflare.kotlin.ApiShield.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.40.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.cloudflare.kotlin

import com.pulumi.cloudflare.kotlin.outputs.ApiShieldAuthIdCharacteristic
import com.pulumi.cloudflare.kotlin.outputs.ApiShieldAuthIdCharacteristic.Companion.toKotlin
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 [ApiShield].
 */
@PulumiTagMarker
public class ApiShieldResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ApiShieldArgs = ApiShieldArgs()

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

/**
 * Provides a resource to manage API Shield configurations.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudflare from "@pulumi/cloudflare";
 * const example = new cloudflare.ApiShield("example", {
 *     zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
 *     authIdCharacteristics: [{
 *         name: "my-example-header",
 *         type: "header",
 *     }],
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_cloudflare as cloudflare
 * example = cloudflare.ApiShield("example",
 *     zone_id="0da42c8d2132a9ddaf714f9e7c920711",
 *     auth_id_characteristics=[{
 *         "name": "my-example-header",
 *         "type": "header",
 *     }])
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Cloudflare = Pulumi.Cloudflare;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Cloudflare.ApiShield("example", new()
 *     {
 *         ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
 *         AuthIdCharacteristics = new[]
 *         {
 *             new Cloudflare.Inputs.ApiShieldAuthIdCharacteristicArgs
 *             {
 *                 Name = "my-example-header",
 *                 Type = "header",
 *             },
 *         },
 *     });
 * });
 * ```
 * ```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.NewApiShield(ctx, "example", &cloudflare.ApiShieldArgs{
 * 			ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
 * 			AuthIdCharacteristics: cloudflare.ApiShieldAuthIdCharacteristicArray{
 * 				&cloudflare.ApiShieldAuthIdCharacteristicArgs{
 * 					Name: pulumi.String("my-example-header"),
 * 					Type: pulumi.String("header"),
 * 				},
 * 			},
 * 		})
 * 		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.ApiShield;
 * import com.pulumi.cloudflare.ApiShieldArgs;
 * import com.pulumi.cloudflare.inputs.ApiShieldAuthIdCharacteristicArgs;
 * 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 ApiShield("example", ApiShieldArgs.builder()
 *             .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
 *             .authIdCharacteristics(ApiShieldAuthIdCharacteristicArgs.builder()
 *                 .name("my-example-header")
 *                 .type("header")
 *                 .build())
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: cloudflare:ApiShield
 *     properties:
 *       zoneId: 0da42c8d2132a9ddaf714f9e7c920711
 *       authIdCharacteristics:
 *         - name: my-example-header
 *           type: header
 * ```
 * 
 */
public class ApiShield internal constructor(
    override val javaResource: com.pulumi.cloudflare.ApiShield,
) : KotlinCustomResource(javaResource, ApiShieldMapper) {
    /**
     * Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
     */
    public val authIdCharacteristics: Output>?
        get() = javaResource.authIdCharacteristics().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
            }).orElse(null)
        })

    /**
     * The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
     */
    public val zoneId: Output
        get() = javaResource.zoneId().applyValue({ args0 -> args0 })
}

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

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

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

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