1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. ApiShieldOperationSchemaValidationSettings
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.ApiShieldOperationSchemaValidationSettings

Explore with Pulumi AI

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleApiShieldOperationSchemaValidationSettings = new cloudflare.ApiShieldOperationSchemaValidationSettings("example_api_shield_operation_schema_validation_settings", {
        zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
        operationId: "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        mitigationAction: "block",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_api_shield_operation_schema_validation_settings = cloudflare.ApiShieldOperationSchemaValidationSettings("example_api_shield_operation_schema_validation_settings",
        zone_id="023e105f4ecef8ad9ca31a8372d0c353",
        operation_id="f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
        mitigation_action="block")
    
    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.NewApiShieldOperationSchemaValidationSettings(ctx, "example_api_shield_operation_schema_validation_settings", &cloudflare.ApiShieldOperationSchemaValidationSettingsArgs{
    			ZoneId:           pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			OperationId:      pulumi.String("f174e90a-fafe-4643-bbbc-4a0ed4fc8415"),
    			MitigationAction: pulumi.String("block"),
    		})
    		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 exampleApiShieldOperationSchemaValidationSettings = new Cloudflare.ApiShieldOperationSchemaValidationSettings("example_api_shield_operation_schema_validation_settings", new()
        {
            ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
            OperationId = "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
            MitigationAction = "block",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.ApiShieldOperationSchemaValidationSettings;
    import com.pulumi.cloudflare.ApiShieldOperationSchemaValidationSettingsArgs;
    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 exampleApiShieldOperationSchemaValidationSettings = new ApiShieldOperationSchemaValidationSettings("exampleApiShieldOperationSchemaValidationSettings", ApiShieldOperationSchemaValidationSettingsArgs.builder()
                .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
                .operationId("f174e90a-fafe-4643-bbbc-4a0ed4fc8415")
                .mitigationAction("block")
                .build());
    
        }
    }
    
    resources:
      exampleApiShieldOperationSchemaValidationSettings:
        type: cloudflare:ApiShieldOperationSchemaValidationSettings
        name: example_api_shield_operation_schema_validation_settings
        properties:
          zoneId: 023e105f4ecef8ad9ca31a8372d0c353
          operationId: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
          mitigationAction: block
    

    Create ApiShieldOperationSchemaValidationSettings Resource

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

    Constructor syntax

    new ApiShieldOperationSchemaValidationSettings(name: string, args: ApiShieldOperationSchemaValidationSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def ApiShieldOperationSchemaValidationSettings(resource_name: str,
                                                   args: ApiShieldOperationSchemaValidationSettingsArgs,
                                                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiShieldOperationSchemaValidationSettings(resource_name: str,
                                                   opts: Optional[ResourceOptions] = None,
                                                   operation_id: Optional[str] = None,
                                                   zone_id: Optional[str] = None,
                                                   mitigation_action: Optional[str] = None)
    func NewApiShieldOperationSchemaValidationSettings(ctx *Context, name string, args ApiShieldOperationSchemaValidationSettingsArgs, opts ...ResourceOption) (*ApiShieldOperationSchemaValidationSettings, error)
    public ApiShieldOperationSchemaValidationSettings(string name, ApiShieldOperationSchemaValidationSettingsArgs args, CustomResourceOptions? opts = null)
    public ApiShieldOperationSchemaValidationSettings(String name, ApiShieldOperationSchemaValidationSettingsArgs args)
    public ApiShieldOperationSchemaValidationSettings(String name, ApiShieldOperationSchemaValidationSettingsArgs args, CustomResourceOptions options)
    
    type: cloudflare:ApiShieldOperationSchemaValidationSettings
    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 ApiShieldOperationSchemaValidationSettingsArgs
    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 ApiShieldOperationSchemaValidationSettingsArgs
    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 ApiShieldOperationSchemaValidationSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiShieldOperationSchemaValidationSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiShieldOperationSchemaValidationSettingsArgs
    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 apiShieldOperationSchemaValidationSettingsResource = new Cloudflare.ApiShieldOperationSchemaValidationSettings("apiShieldOperationSchemaValidationSettingsResource", new()
    {
        OperationId = "string",
        ZoneId = "string",
        MitigationAction = "string",
    });
    
    example, err := cloudflare.NewApiShieldOperationSchemaValidationSettings(ctx, "apiShieldOperationSchemaValidationSettingsResource", &cloudflare.ApiShieldOperationSchemaValidationSettingsArgs{
    	OperationId:      pulumi.String("string"),
    	ZoneId:           pulumi.String("string"),
    	MitigationAction: pulumi.String("string"),
    })
    
    var apiShieldOperationSchemaValidationSettingsResource = new ApiShieldOperationSchemaValidationSettings("apiShieldOperationSchemaValidationSettingsResource", ApiShieldOperationSchemaValidationSettingsArgs.builder()
        .operationId("string")
        .zoneId("string")
        .mitigationAction("string")
        .build());
    
    api_shield_operation_schema_validation_settings_resource = cloudflare.ApiShieldOperationSchemaValidationSettings("apiShieldOperationSchemaValidationSettingsResource",
        operation_id="string",
        zone_id="string",
        mitigation_action="string")
    
    const apiShieldOperationSchemaValidationSettingsResource = new cloudflare.ApiShieldOperationSchemaValidationSettings("apiShieldOperationSchemaValidationSettingsResource", {
        operationId: "string",
        zoneId: "string",
        mitigationAction: "string",
    });
    
    type: cloudflare:ApiShieldOperationSchemaValidationSettings
    properties:
        mitigationAction: string
        operationId: string
        zoneId: string
    

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

    OperationId string
    UUID
    ZoneId string
    Identifier
    MitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    OperationId string
    UUID
    ZoneId string
    Identifier
    MitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId String
    UUID
    zoneId String
    Identifier
    mitigationAction String
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId string
    UUID
    zoneId string
    Identifier
    mitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operation_id str
    UUID
    zone_id str
    Identifier
    mitigation_action str
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId String
    UUID
    zoneId String
    Identifier
    mitigationAction String
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".

    Outputs

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

    Get an existing ApiShieldOperationSchemaValidationSettings 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?: ApiShieldOperationSchemaValidationSettingsState, opts?: CustomResourceOptions): ApiShieldOperationSchemaValidationSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            mitigation_action: Optional[str] = None,
            operation_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> ApiShieldOperationSchemaValidationSettings
    func GetApiShieldOperationSchemaValidationSettings(ctx *Context, name string, id IDInput, state *ApiShieldOperationSchemaValidationSettingsState, opts ...ResourceOption) (*ApiShieldOperationSchemaValidationSettings, error)
    public static ApiShieldOperationSchemaValidationSettings Get(string name, Input<string> id, ApiShieldOperationSchemaValidationSettingsState? state, CustomResourceOptions? opts = null)
    public static ApiShieldOperationSchemaValidationSettings get(String name, Output<String> id, ApiShieldOperationSchemaValidationSettingsState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:ApiShieldOperationSchemaValidationSettings    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:
    MitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    OperationId string
    UUID
    ZoneId string
    Identifier
    MitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    OperationId string
    UUID
    ZoneId string
    Identifier
    mitigationAction String
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId String
    UUID
    zoneId String
    Identifier
    mitigationAction string
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId string
    UUID
    zoneId string
    Identifier
    mitigation_action str
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operation_id str
    UUID
    zone_id str
    Identifier
    mitigationAction String
    When set, this applies a mitigation action to this operation - log log request when request does not conform to schema for this operation - block deny access to the site when request does not conform to schema for this operation - none will skip mitigation for this operation - null indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied Available values: "log", "block", "none".
    operationId String
    UUID
    zoneId String
    Identifier

    Import

    $ pulumi import cloudflare:index/apiShieldOperationSchemaValidationSettings:ApiShieldOperationSchemaValidationSettings example '<zone_id>/<operation_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