com.pulumi.cloudflare.kotlin.ApiShieldOperation.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.
The 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 [ApiShieldOperation].
 */
@PulumiTagMarker
public class ApiShieldOperationResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: ApiShieldOperationArgs = ApiShieldOperationArgs()

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

/**
 * Provides a resource to manage an operation in API Shield Endpoint Management.
 * ## Example Usage
 * 
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cloudflare from "@pulumi/cloudflare";
 * const example = new cloudflare.ApiShieldOperation("example", {
 *     zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
 *     method: "GET",
 *     host: "api.example.com",
 *     endpoint: "/path",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_cloudflare as cloudflare
 * example = cloudflare.ApiShieldOperation("example",
 *     zone_id="0da42c8d2132a9ddaf714f9e7c920711",
 *     method="GET",
 *     host="api.example.com",
 *     endpoint="/path")
 * ```
 * ```csharp
 * using System.Collections.Generic;
 * using System.Linq;
 * using Pulumi;
 * using Cloudflare = Pulumi.Cloudflare;
 * return await Deployment.RunAsync(() =>
 * {
 *     var example = new Cloudflare.ApiShieldOperation("example", new()
 *     {
 *         ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
 *         Method = "GET",
 *         Host = "api.example.com",
 *         Endpoint = "/path",
 *     });
 * });
 * ```
 * ```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.NewApiShieldOperation(ctx, "example", &cloudflare.ApiShieldOperationArgs{
 * 			ZoneId:   pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
 * 			Method:   pulumi.String("GET"),
 * 			Host:     pulumi.String("api.example.com"),
 * 			Endpoint: pulumi.String("/path"),
 * 		})
 * 		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.ApiShieldOperation;
 * import com.pulumi.cloudflare.ApiShieldOperationArgs;
 * 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 ApiShieldOperation("example", ApiShieldOperationArgs.builder()
 *             .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
 *             .method("GET")
 *             .host("api.example.com")
 *             .endpoint("/path")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * resources:
 *   example:
 *     type: cloudflare:ApiShieldOperation
 *     properties:
 *       zoneId: 0da42c8d2132a9ddaf714f9e7c920711
 *       method: GET
 *       host: api.example.com
 *       endpoint: /path
 * ```
 * 
 */
public class ApiShieldOperation internal constructor(
    override val javaResource: com.pulumi.cloudflare.ApiShieldOperation,
) : KotlinCustomResource(javaResource, ApiShieldOperationMapper) {
    /**
     * The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with `{varN}`, starting with `{var1}`. This will then be [Cloudflare-normalized](https://developers.cloudflare.com/rules/normalization/how-it-works/). **Modifying this attribute will force creation of a new resource.**
     */
    public val endpoint: Output
        get() = javaResource.endpoint().applyValue({ args0 -> args0 })

    /**
     * RFC3986-compliant host. **Modifying this attribute will force creation of a new resource.**
     */
    public val host: Output
        get() = javaResource.host().applyValue({ args0 -> args0 })

    /**
     * The HTTP method used to access the endpoint. **Modifying this attribute will force creation of a new resource.**
     */
    public val method: Output
        get() = javaResource.method().applyValue({ args0 -> args0 })

    /**
     * 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 ApiShieldOperationMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.cloudflare.ApiShieldOperation::class == javaResource::class

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

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

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