Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ApiShield
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.ApiShield

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    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",
    }])

    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
	})
}

    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 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

    Create ApiShield Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiShield(name: string, args: ApiShieldArgs, opts?: CustomResourceOptions);
    @overload
def ApiShield(resource_name: str,
              args: ApiShieldArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def ApiShield(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auth_id_characteristics: Optional[Sequence[ApiShieldAuthIdCharacteristicArgs]] = None,
              zone_id: Optional[str] = None)
    func NewApiShield(ctx *Context, name string, args ApiShieldArgs, opts ...ResourceOption) (*ApiShield, error)
    public ApiShield(string name, ApiShieldArgs args, CustomResourceOptions? opts = null)
    public ApiShield(String name, ApiShieldArgs args)
public ApiShield(String name, ApiShieldArgs args, CustomResourceOptions options)

    type: cloudflare:ApiShield
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApiShieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiShieldArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiShieldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiShieldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiShieldArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiShieldResource = new Cloudflare.ApiShield("apiShieldResource", new()
{
    AuthIdCharacteristics = new[]
    {
        new Cloudflare.Inputs.ApiShieldAuthIdCharacteristicArgs
        {
            Name = "string",
            Type = "string",
        },
    },
    ZoneId = "string",
});

    example, err := cloudflare.NewApiShield(ctx, "apiShieldResource", &cloudflare.ApiShieldArgs{
	AuthIdCharacteristics: cloudflare.ApiShieldAuthIdCharacteristicArray{
		&cloudflare.ApiShieldAuthIdCharacteristicArgs{
			Name: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	ZoneId: pulumi.String("string"),
})

    var apiShieldResource = new ApiShield("apiShieldResource", ApiShieldArgs.builder()
    .authIdCharacteristics(ApiShieldAuthIdCharacteristicArgs.builder()
        .name("string")
        .type("string")
        .build())
    .zoneId("string")
    .build());

    api_shield_resource = cloudflare.ApiShield("apiShieldResource",
    auth_id_characteristics=[{
        "name": "string",
        "type": "string",
    }],
    zone_id="string")

    const apiShieldResource = new cloudflare.ApiShield("apiShieldResource", {
    authIdCharacteristics: [{
        name: "string",
        type: "string",
    }],
    zoneId: "string",
});

    type: cloudflare:ApiShield
properties:
    authIdCharacteristics:
        - name: string
          type: string
    zoneId: string

    ApiShield Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ApiShield resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiShield resource produces the following output properties:

    Errors List<ApiShieldError>
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages List<ApiShieldMessage>
    Success bool
    Whether the API call was successful
    Errors []ApiShieldError
    Id string
    The provider-assigned unique ID for this managed resource.
    Messages []ApiShieldMessage
    Success bool
    Whether the API call was successful
    errors List<ApiShieldError>
    id String
    The provider-assigned unique ID for this managed resource.
    messages List<ApiShieldMessage>
    success Boolean
    Whether the API call was successful
    errors ApiShieldError[]
    id string
    The provider-assigned unique ID for this managed resource.
    messages ApiShieldMessage[]
    success boolean
    Whether the API call was successful
    errors Sequence[ApiShieldError]
    id str
    The provider-assigned unique ID for this managed resource.
    messages Sequence[ApiShieldMessage]
    success bool
    Whether the API call was successful
    errors List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    messages List<Property Map>
    success Boolean
    Whether the API call was successful

    Look up Existing ApiShield Resource

    Get an existing ApiShield resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiShieldState, opts?: CustomResourceOptions): ApiShield
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_id_characteristics: Optional[Sequence[ApiShieldAuthIdCharacteristicArgs]] = None,
        errors: Optional[Sequence[ApiShieldErrorArgs]] = None,
        messages: Optional[Sequence[ApiShieldMessageArgs]] = None,
        success: Optional[bool] = None,
        zone_id: Optional[str] = None) -> ApiShield
    func GetApiShield(ctx *Context, name string, id IDInput, state *ApiShieldState, opts ...ResourceOption) (*ApiShield, error)
    public static ApiShield Get(string name, Input<string> id, ApiShieldState? state, CustomResourceOptions? opts = null)
    public static ApiShield get(String name, Output<String> id, ApiShieldState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:ApiShield    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:

    Supporting Types

    ApiShieldAuthIdCharacteristic, ApiShieldAuthIdCharacteristicArgs

    Name string
    The name of the characteristic field, i.e., the header or cookie name.
    Type string
    The type of characteristic. Available values: "header", "cookie".
    Name string
    The name of the characteristic field, i.e., the header or cookie name.
    Type string
    The type of characteristic. Available values: "header", "cookie".
    name String
    The name of the characteristic field, i.e., the header or cookie name.
    type String
    The type of characteristic. Available values: "header", "cookie".
    name string
    The name of the characteristic field, i.e., the header or cookie name.
    type string
    The type of characteristic. Available values: "header", "cookie".
    name str
    The name of the characteristic field, i.e., the header or cookie name.
    type str
    The type of characteristic. Available values: "header", "cookie".
    name String
    The name of the characteristic field, i.e., the header or cookie name.
    type String
    The type of characteristic. Available values: "header", "cookie".

    ApiShieldError, ApiShieldErrorArgs

    Code int
    Message string
    Code int
    Message string
    code Integer
    message String
    code number
    message string
    code int
    message str
    code Number
    message String

    ApiShieldMessage, ApiShieldMessageArgs

    Code int
    Message string
    Code int
    Message string
    code Integer
    message String
    code number
    message string
    code int
    message str
    code Number
    message String

    Import

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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare