Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ApiShieldOperation
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.ApiShieldOperation

Explore with Pulumi AI

Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare

Api shield operation

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const example = new cloudflare.ApiShieldOperation("example", {
    zoneId: "0da42c8d2132a9ddaf714f9e7c920711",
    method: "GET",
    host: "api.example.com",
    endpoint: "/path",
});
Copy
import pulumi
import pulumi_cloudflare as cloudflare

example = cloudflare.ApiShieldOperation("example",
    zone_id="0da42c8d2132a9ddaf714f9e7c920711",
    method="GET",
    host="api.example.com",
    endpoint="/path")
Copy
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.NewApiShieldOperation(ctx, "example", &cloudflare.ApiShieldOperationArgs{
			ZoneId:   pulumi.String("0da42c8d2132a9ddaf714f9e7c920711"),
			Method:   pulumi.String("GET"),
			Host:     pulumi.String("api.example.com"),
			Endpoint: pulumi.String("/path"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var example = new Cloudflare.ApiShieldOperation("example", new()
    {
        ZoneId = "0da42c8d2132a9ddaf714f9e7c920711",
        Method = "GET",
        Host = "api.example.com",
        Endpoint = "/path",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.ApiShieldOperation;
import com.pulumi.cloudflare.ApiShieldOperationArgs;
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 ApiShieldOperation("example", ApiShieldOperationArgs.builder()
            .zoneId("0da42c8d2132a9ddaf714f9e7c920711")
            .method("GET")
            .host("api.example.com")
            .endpoint("/path")
            .build());

    }
}
Copy
resources:
  example:
    type: cloudflare:ApiShieldOperation
    properties:
      zoneId: 0da42c8d2132a9ddaf714f9e7c920711
      method: GET
      host: api.example.com
      endpoint: /path
Copy

Create ApiShieldOperation Resource

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

Constructor syntax

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

@overload
def ApiShieldOperation(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       endpoint: Optional[str] = None,
                       host: Optional[str] = None,
                       method: Optional[str] = None,
                       zone_id: Optional[str] = None)
func NewApiShieldOperation(ctx *Context, name string, args ApiShieldOperationArgs, opts ...ResourceOption) (*ApiShieldOperation, error)
public ApiShieldOperation(string name, ApiShieldOperationArgs args, CustomResourceOptions? opts = null)
public ApiShieldOperation(String name, ApiShieldOperationArgs args)
public ApiShieldOperation(String name, ApiShieldOperationArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApiShieldOperationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApiShieldOperationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApiShieldOperationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApiShieldOperationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApiShieldOperationArgs
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 apiShieldOperationResource = new Cloudflare.ApiShieldOperation("apiShieldOperationResource", new()
{
    Endpoint = "string",
    Host = "string",
    Method = "string",
    ZoneId = "string",
});
Copy
example, err := cloudflare.NewApiShieldOperation(ctx, "apiShieldOperationResource", &cloudflare.ApiShieldOperationArgs{
	Endpoint: pulumi.String("string"),
	Host:     pulumi.String("string"),
	Method:   pulumi.String("string"),
	ZoneId:   pulumi.String("string"),
})
Copy
var apiShieldOperationResource = new ApiShieldOperation("apiShieldOperationResource", ApiShieldOperationArgs.builder()
    .endpoint("string")
    .host("string")
    .method("string")
    .zoneId("string")
    .build());
Copy
api_shield_operation_resource = cloudflare.ApiShieldOperation("apiShieldOperationResource",
    endpoint="string",
    host="string",
    method="string",
    zone_id="string")
Copy
const apiShieldOperationResource = new cloudflare.ApiShieldOperation("apiShieldOperationResource", {
    endpoint: "string",
    host: "string",
    method: "string",
    zoneId: "string",
});
Copy
type: cloudflare:ApiShieldOperation
properties:
    endpoint: string
    host: string
    method: string
    zoneId: string
Copy

ApiShieldOperation 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 ApiShieldOperation resource accepts the following input properties:

Endpoint This property is required. string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
Host This property is required. string
RFC3986-compliant host
Method This property is required. string
The HTTP method used to access the endpoint
ZoneId This property is required. string
The zone identifier to target for the resource.
Endpoint This property is required. string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
Host This property is required. string
RFC3986-compliant host
Method This property is required. string
The HTTP method used to access the endpoint
ZoneId This property is required. string
The zone identifier to target for the resource.
endpoint This property is required. String
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host This property is required. String
RFC3986-compliant host
method This property is required. String
The HTTP method used to access the endpoint
zoneId This property is required. String
The zone identifier to target for the resource.
endpoint This property is required. string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host This property is required. string
RFC3986-compliant host
method This property is required. string
The HTTP method used to access the endpoint
zoneId This property is required. string
The zone identifier to target for the resource.
endpoint This property is required. str
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host This property is required. str
RFC3986-compliant host
method This property is required. str
The HTTP method used to access the endpoint
zone_id This property is required. str
The zone identifier to target for the resource.
endpoint This property is required. String
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host This property is required. String
RFC3986-compliant host
method This property is required. String
The HTTP method used to access the endpoint
zoneId This property is required. String
The zone identifier to target for the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiShieldOperation 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 ApiShieldOperation Resource

Get an existing ApiShieldOperation 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?: ApiShieldOperationState, opts?: CustomResourceOptions): ApiShieldOperation
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        endpoint: Optional[str] = None,
        host: Optional[str] = None,
        method: Optional[str] = None,
        zone_id: Optional[str] = None) -> ApiShieldOperation
func GetApiShieldOperation(ctx *Context, name string, id IDInput, state *ApiShieldOperationState, opts ...ResourceOption) (*ApiShieldOperation, error)
public static ApiShieldOperation Get(string name, Input<string> id, ApiShieldOperationState? state, CustomResourceOptions? opts = null)
public static ApiShieldOperation get(String name, Output<String> id, ApiShieldOperationState state, CustomResourceOptions options)
resources:  _:    type: cloudflare:ApiShieldOperation    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Endpoint string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
Host string
RFC3986-compliant host
Method string
The HTTP method used to access the endpoint
ZoneId string
The zone identifier to target for the resource.
Endpoint string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
Host string
RFC3986-compliant host
Method string
The HTTP method used to access the endpoint
ZoneId string
The zone identifier to target for the resource.
endpoint String
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host String
RFC3986-compliant host
method String
The HTTP method used to access the endpoint
zoneId String
The zone identifier to target for the resource.
endpoint string
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host string
RFC3986-compliant host
method string
The HTTP method used to access the endpoint
zoneId string
The zone identifier to target for the resource.
endpoint str
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host str
RFC3986-compliant host
method str
The HTTP method used to access the endpoint
zone_id str
The zone identifier to target for the resource.
endpoint String
The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}. This will then be Cloudflare-normalized
host String
RFC3986-compliant host
method String
The HTTP method used to access the endpoint
zoneId String
The zone identifier to target for the resource.

Package Details

Repository
Cloudflare pulumi/pulumi-cloudflare
License
Apache-2.0
Notes
This Pulumi package is based on the cloudflare Terraform Provider.
Cloudflare v5.49.1 published on Tuesday, Feb 18, 2025 by Pulumi
pulumi/pulumi-cloudflare