ApiShield

class ApiShield : KotlinCustomResource

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
const exampleApiShield = new cloudflare.ApiShield("example_api_shield", {
zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
authIdCharacteristics: [{
name: "authorization",
type: "header",
}],
});
import pulumi
import pulumi_cloudflare as cloudflare
example_api_shield = cloudflare.ApiShield("example_api_shield",
zone_id="023e105f4ecef8ad9ca31a8372d0c353",
auth_id_characteristics=[{
"name": "authorization",
"type": "header",
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
var exampleApiShield = new Cloudflare.ApiShield("example_api_shield", new()
{
ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
AuthIdCharacteristics = new[]
{
new Cloudflare.Inputs.ApiShieldAuthIdCharacteristicArgs
{
Name = "authorization",
Type = "header",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := cloudflare.NewApiShield(ctx, "example_api_shield", &cloudflare.ApiShieldArgs{
ZoneId: pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
AuthIdCharacteristics: cloudflare.ApiShieldAuthIdCharacteristicArray{
&cloudflare.ApiShieldAuthIdCharacteristicArgs{
Name: pulumi.String("authorization"),
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 exampleApiShield = new ApiShield("exampleApiShield", ApiShieldArgs.builder()
.zoneId("023e105f4ecef8ad9ca31a8372d0c353")
.authIdCharacteristics(ApiShieldAuthIdCharacteristicArgs.builder()
.name("authorization")
.type("header")
.build())
.build());
}
}
resources:
exampleApiShield:
type: cloudflare:ApiShield
name: example_api_shield
properties:
zoneId: 023e105f4ecef8ad9ca31a8372d0c353
authIdCharacteristics:
- name: authorization
type: header

Import

$ pulumi import cloudflare:index/apiShield:ApiShield example '<zone_id>'

Properties

Link copied to clipboard
val errors: Output<List<ApiShieldError>>
Link copied to clipboard
val id: Output<String>
Link copied to clipboard
Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val success: Output<Boolean>

Whether the API call was successful

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val zoneId: Output<String>

Identifier