Cloudflare v6.0.1, Apr 16 25

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

cloudflare.getApiShieldSchemas

Explore with Pulumi AI

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const exampleApiShieldSchemas = cloudflare.getApiShieldSchemas({
    zoneId: "023e105f4ecef8ad9ca31a8372d0c353",
    validationEnabled: true,
});

import pulumi
import pulumi_cloudflare as cloudflare

example_api_shield_schemas = cloudflare.get_api_shield_schemas(zone_id="023e105f4ecef8ad9ca31a8372d0c353",
    validation_enabled=True)

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.LookupApiShieldSchemas(ctx, &cloudflare.LookupApiShieldSchemasArgs{
			ZoneId:            "023e105f4ecef8ad9ca31a8372d0c353",
			ValidationEnabled: pulumi.BoolRef(true),
		}, nil)
		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 exampleApiShieldSchemas = Cloudflare.GetApiShieldSchemas.Invoke(new()
    {
        ZoneId = "023e105f4ecef8ad9ca31a8372d0c353",
        ValidationEnabled = true,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetApiShieldSchemasArgs;
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) {
        final var exampleApiShieldSchemas = CloudflareFunctions.getApiShieldSchemas(GetApiShieldSchemasArgs.builder()
            .zoneId("023e105f4ecef8ad9ca31a8372d0c353")
            .validationEnabled(true)
            .build());

    }
}

variables:
  exampleApiShieldSchemas:
    fn::invoke:
      function: cloudflare:getApiShieldSchemas
      arguments:
        zoneId: 023e105f4ecef8ad9ca31a8372d0c353
        validationEnabled: true

Using getApiShieldSchemas

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getApiShieldSchemas(args: GetApiShieldSchemasArgs, opts?: InvokeOptions): Promise<GetApiShieldSchemasResult>
function getApiShieldSchemasOutput(args: GetApiShieldSchemasOutputArgs, opts?: InvokeOptions): Output<GetApiShieldSchemasResult>

def get_api_shield_schemas(max_items: Optional[int] = None,
                           omit_source: Optional[bool] = None,
                           validation_enabled: Optional[bool] = None,
                           zone_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetApiShieldSchemasResult
def get_api_shield_schemas_output(max_items: Optional[pulumi.Input[int]] = None,
                           omit_source: Optional[pulumi.Input[bool]] = None,
                           validation_enabled: Optional[pulumi.Input[bool]] = None,
                           zone_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetApiShieldSchemasResult]

func LookupApiShieldSchemas(ctx *Context, args *LookupApiShieldSchemasArgs, opts ...InvokeOption) (*LookupApiShieldSchemasResult, error)
func LookupApiShieldSchemasOutput(ctx *Context, args *LookupApiShieldSchemasOutputArgs, opts ...InvokeOption) LookupApiShieldSchemasResultOutput

> Note: This function is named LookupApiShieldSchemas in the Go SDK.

public static class GetApiShieldSchemas 
{
    public static Task<GetApiShieldSchemasResult> InvokeAsync(GetApiShieldSchemasArgs args, InvokeOptions? opts = null)
    public static Output<GetApiShieldSchemasResult> Invoke(GetApiShieldSchemasInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiShieldSchemasResult> getApiShieldSchemas(GetApiShieldSchemasArgs args, InvokeOptions options)
public static Output<GetApiShieldSchemasResult> getApiShieldSchemas(GetApiShieldSchemasArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getApiShieldSchemas:getApiShieldSchemas
  arguments:
    # arguments dictionary

The following arguments are supported:

ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
ValidationEnabled bool: Flag whether schema is enabled for validation.

ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
ValidationEnabled bool: Flag whether schema is enabled for validation.

zoneId String: Identifier
maxItems Integer: Max items to fetch, default: 1000
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
validationEnabled Boolean: Flag whether schema is enabled for validation.

zoneId string: Identifier
maxItems number: Max items to fetch, default: 1000
omitSource boolean: Omit the source-files of schemas and only retrieve their meta-data.
validationEnabled boolean: Flag whether schema is enabled for validation.

zone_id str: Identifier
max_items int: Max items to fetch, default: 1000
omit_source bool: Omit the source-files of schemas and only retrieve their meta-data.
validation_enabled bool: Flag whether schema is enabled for validation.

zoneId String: Identifier
maxItems Number: Max items to fetch, default: 1000
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
validationEnabled Boolean: Flag whether schema is enabled for validation.

getApiShieldSchemas Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
Results List<GetApiShieldSchemasResult>: The items returned by the data source
ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000
ValidationEnabled bool: Flag whether schema is enabled for validation.

Id string: The provider-assigned unique ID for this managed resource.
OmitSource bool: Omit the source-files of schemas and only retrieve their meta-data.
Results []GetApiShieldSchemasResult: The items returned by the data source
ZoneId string: Identifier
MaxItems int: Max items to fetch, default: 1000
ValidationEnabled bool: Flag whether schema is enabled for validation.

id String: The provider-assigned unique ID for this managed resource.
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
results List<GetApiShieldSchemasResult>: The items returned by the data source
zoneId String: Identifier
maxItems Integer: Max items to fetch, default: 1000
validationEnabled Boolean: Flag whether schema is enabled for validation.

id string: The provider-assigned unique ID for this managed resource.
omitSource boolean: Omit the source-files of schemas and only retrieve their meta-data.
results GetApiShieldSchemasResult[]: The items returned by the data source
zoneId string: Identifier
maxItems number: Max items to fetch, default: 1000
validationEnabled boolean: Flag whether schema is enabled for validation.

id str: The provider-assigned unique ID for this managed resource.
omit_source bool: Omit the source-files of schemas and only retrieve their meta-data.
results Sequence[GetApiShieldSchemasResult]: The items returned by the data source
zone_id str: Identifier
max_items int: Max items to fetch, default: 1000
validation_enabled bool: Flag whether schema is enabled for validation.

id String: The provider-assigned unique ID for this managed resource.
omitSource Boolean: Omit the source-files of schemas and only retrieve their meta-data.
results List<Property Map>: The items returned by the data source
zoneId String: Identifier
maxItems Number: Max items to fetch, default: 1000
validationEnabled Boolean: Flag whether schema is enabled for validation.

Supporting Types

GetApiShieldSchemasResult

CreatedAt string
Kind string: Kind of schema Available values: "openapi_v3".
Name string: Name of the schema
SchemaId string: UUID
Source string: Source of the schema
ValidationEnabled bool: Flag whether schema is enabled for validation.

CreatedAt string
Kind string: Kind of schema Available values: "openapi_v3".
Name string: Name of the schema
SchemaId string: UUID
Source string: Source of the schema
ValidationEnabled bool: Flag whether schema is enabled for validation.

createdAt String
kind String: Kind of schema Available values: "openapi_v3".
name String: Name of the schema
schemaId String: UUID
source String: Source of the schema
validationEnabled Boolean: Flag whether schema is enabled for validation.

createdAt string
kind string: Kind of schema Available values: "openapi_v3".
name string: Name of the schema
schemaId string: UUID
source string: Source of the schema
validationEnabled boolean: Flag whether schema is enabled for validation.

created_at str
kind str: Kind of schema Available values: "openapi_v3".
name str: Name of the schema
schema_id str: UUID
source str: Source of the schema
validation_enabled bool: Flag whether schema is enabled for validation.

createdAt String
kind String: Kind of schema Available values: "openapi_v3".
name String: Name of the schema
schemaId String: UUID
source String: Source of the schema
validationEnabled Boolean: Flag whether schema is enabled for validation.

Package Details

Repository: Cloudflare pulumi/pulumi-cloudflare
License: Apache-2.0
Notes: This Pulumi package is based on the cloudflare Terraform Provider.

Cloudflare v6.0.1 published on Wednesday, Apr 16, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getApiShieldSchemas

On this page

On this page

Example Usage

Using getApiShieldSchemas

getApiShieldSchemas Result

Supporting Types

GetApiShieldSchemasResult

Package Details

On this page

On this page