ApiShieldArgs

data class ApiShieldArgs(val authIdCharacteristics: Output<List<ApiShieldAuthIdCharacteristicArgs>>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<ApiShieldArgs>

Provides a resource to manage API Shield configurations.

Example Usage

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",
}],
});
import pulumi
import pulumi_cloudflare as cloudflare
example = cloudflare.ApiShield("example",
zone_id="0da42c8d2132a9ddaf714f9e7c920711",
auth_id_characteristics=[{
"name": "my-example-header",
"type": "header",
}])
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",
},
},
});
});
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
})
}
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());
}
}
resources:
example:
type: cloudflare:ApiShield
properties:
zoneId: 0da42c8d2132a9ddaf714f9e7c920711
authIdCharacteristics:
- name: my-example-header
type: header

Constructors

Link copied to clipboard
constructor(authIdCharacteristics: Output<List<ApiShieldAuthIdCharacteristicArgs>>? = null, zoneId: Output<String>? = null)

Properties

Link copied to clipboard

Characteristics define properties across which auth-ids can be computed in a privacy-preserving manner.

Link copied to clipboard
val zoneId: Output<String>? = null

The zone identifier to target for the resource. Modifying this attribute will force creation of a new resource.

Functions

Link copied to clipboard
open override fun toJava(): ApiShieldArgs