com.pulumi.cloudflare.kotlin.ApiShieldArgs.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.
The newest version!
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.cloudflare.kotlin
import com.pulumi.cloudflare.ApiShieldArgs.builder
import com.pulumi.cloudflare.kotlin.inputs.ApiShieldAuthIdCharacteristicArgs
import com.pulumi.cloudflare.kotlin.inputs.ApiShieldAuthIdCharacteristicArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.jvm.JvmName
/**
* 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
* ```
*
* @property authIdCharacteristics Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
* @property zoneId The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
public data class ApiShieldArgs(
public val authIdCharacteristics: Output>? = null,
public val zoneId: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.cloudflare.ApiShieldArgs =
com.pulumi.cloudflare.ApiShieldArgs.builder()
.authIdCharacteristics(
authIdCharacteristics?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> args0.toJava() })
})
}),
)
.zoneId(zoneId?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [ApiShieldArgs].
*/
@PulumiTagMarker
public class ApiShieldArgsBuilder internal constructor() {
private var authIdCharacteristics: Output>? = null
private var zoneId: Output? = null
/**
* @param value Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("bpgclrnwebgppyba")
public suspend fun authIdCharacteristics(`value`: Output>) {
this.authIdCharacteristics = value
}
@JvmName("xamxsoqjoexagids")
public suspend fun authIdCharacteristics(vararg values: Output) {
this.authIdCharacteristics = Output.all(values.asList())
}
/**
* @param values Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("wfojbyegddywsefg")
public suspend fun authIdCharacteristics(values: List>) {
this.authIdCharacteristics = Output.all(values)
}
/**
* @param value The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
@JvmName("ogydwikexvpwhtyc")
public suspend fun zoneId(`value`: Output) {
this.zoneId = value
}
/**
* @param value Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("kvffepfyhlqtqoee")
public suspend fun authIdCharacteristics(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.authIdCharacteristics = mapped
}
/**
* @param argument Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("fqkarrxwkqwnlpwj")
public suspend fun authIdCharacteristics(argument: List Unit>) {
val toBeMapped = argument.toList().map {
ApiShieldAuthIdCharacteristicArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.authIdCharacteristics = mapped
}
/**
* @param argument Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("jmvvbaiobeokhnee")
public suspend fun authIdCharacteristics(vararg argument: suspend ApiShieldAuthIdCharacteristicArgsBuilder.() -> Unit) {
val toBeMapped = argument.toList().map {
ApiShieldAuthIdCharacteristicArgsBuilder().applySuspend { it() }.build()
}
val mapped = of(toBeMapped)
this.authIdCharacteristics = mapped
}
/**
* @param argument Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("eeccsfkccsmjwyhc")
public suspend fun authIdCharacteristics(argument: suspend ApiShieldAuthIdCharacteristicArgsBuilder.() -> Unit) {
val toBeMapped = listOf(
ApiShieldAuthIdCharacteristicArgsBuilder().applySuspend {
argument()
}.build(),
)
val mapped = of(toBeMapped)
this.authIdCharacteristics = mapped
}
/**
* @param values Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.
*/
@JvmName("ufygwfukqccunbrr")
public suspend fun authIdCharacteristics(vararg values: ApiShieldAuthIdCharacteristicArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.authIdCharacteristics = mapped
}
/**
* @param value The zone identifier to target for the resource. **Modifying this attribute will force creation of a new resource.**
*/
@JvmName("jqivpapixgylucuw")
public suspend fun zoneId(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.zoneId = mapped
}
internal fun build(): ApiShieldArgs = ApiShieldArgs(
authIdCharacteristics = authIdCharacteristics,
zoneId = zoneId,
)
}