cloudflare logo
Cloudflare v4.15.0, Jan 10 23

cloudflare.ApiShield

Provides a resource to manage API Shield configurations.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.ApiShield("example", new()
    {
        AuthIdCharacteristics = new[]
        {
            new Cloudflare.Inputs.ApiShieldAuthIdCharacteristicArgs
            {
                Name = "my-example-header",
                Type = "header",
            },
        },
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
    });

});
package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v4/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{
			AuthIdCharacteristics: cloudflare.ApiShieldAuthIdCharacteristicArray{
				&cloudflare.ApiShieldAuthIdCharacteristicArgs{
					Name: pulumi.String("my-example-header"),
					Type: pulumi.String("header"),
				},
			},
			ZoneId: pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
		})
		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()        
            .authIdCharacteristics(ApiShieldAuthIdCharacteristicArgs.builder()
                .name("my-example-header")
                .type("header")
                .build())
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .build());

    }
}
import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.ApiShield("example",
    auth_id_characteristics=[cloudflare.ApiShieldAuthIdCharacteristicArgs(
        name="my-example-header",
        type="header",
    )],
    zone_id="0da42c8d2132a9ddaf714f9e7c920711")
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.ApiShield("example", {
    authIdCharacteristics: [{
        name: "my-example-header",
        type: "header",
    }],
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
});
resources:
  example:
    type: cloudflare:ApiShield
    properties:
      authIdCharacteristics:
        - name: my-example-header
          type: header
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711

Create ApiShield Resource

new ApiShield(name: string, args: ApiShieldArgs, opts?: CustomResourceOptions);
@overload
def ApiShield(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              auth_id_characteristics: Optional[Sequence[ApiShieldAuthIdCharacteristicArgs]] = None,
              zone_id: Optional[str] = None)
@overload
def ApiShield(resource_name: str,
              args: ApiShieldArgs,
              opts: Optional[ResourceOptions] = 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.

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.

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

The ApiShield resource accepts the following input properties:

ZoneId string

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

AuthIdCharacteristics List<ApiShieldAuthIdCharacteristicArgs>

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

ZoneId string

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

AuthIdCharacteristics []ApiShieldAuthIdCharacteristicArgs

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

zoneId String

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

authIdCharacteristics List<ApiShieldAuthIdCharacteristicArgs>

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

zoneId string

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

authIdCharacteristics ApiShieldAuthIdCharacteristicArgs[]

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

zone_id str

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

auth_id_characteristics Sequence[ApiShieldAuthIdCharacteristicArgs]

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

zoneId String

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

authIdCharacteristics List<Property Map>

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

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

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,
        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)
Resource lookup is not supported in YAML
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:
AuthIdCharacteristics List<ApiShieldAuthIdCharacteristicArgs>

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

ZoneId string

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

AuthIdCharacteristics []ApiShieldAuthIdCharacteristicArgs

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

ZoneId string

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

authIdCharacteristics List<ApiShieldAuthIdCharacteristicArgs>

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

zoneId String

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

authIdCharacteristics ApiShieldAuthIdCharacteristicArgs[]

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

zoneId string

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

auth_id_characteristics Sequence[ApiShieldAuthIdCharacteristicArgs]

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

zone_id str

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

authIdCharacteristics List<Property Map>

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

zoneId String

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

Supporting Types

ApiShieldAuthIdCharacteristic

Name string

The name of the characteristic.

Type string

The type of characteristic. Available values: header, cookie.

Name string

The name of the characteristic.

Type string

The type of characteristic. Available values: header, cookie.

name String

The name of the characteristic.

type String

The type of characteristic. Available values: header, cookie.

name string

The name of the characteristic.

type string

The type of characteristic. Available values: header, cookie.

name str

The name of the characteristic.

type str

The type of characteristic. Available values: header, cookie.

name String

The name of the characteristic.

type String

The type of characteristic. Available values: header, cookie.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes

This Pulumi package is based on the cloudflare Terraform Provider.