Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigApi
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigApi

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an APIG API resource within FlexibleEngine.

    Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const groupId = config.requireObject("groupId");
const apiName = config.requireObject("apiName");
const customResponseId = config.requireObject("customResponseId");
const customAuthId = config.requireObject("customAuthId");
const vpcChannelId = config.requireObject("vpcChannelId");
const test = new flexibleengine.ApigApi("test", {
    instanceId: instanceId,
    groupId: groupId,
    type: "Public",
    requestProtocol: "HTTP",
    requestMethod: "POST",
    requestPath: "/terraform/users",
    securityAuthentication: "AUTHORIZER",
    matching: "Exact",
    successResponse: "Successful",
    responseId: customResponseId,
    authorizerId: customAuthId,
    backendParams: [{
        type: "SYSTEM",
        name: "X-User-Auth",
        location: "HEADER",
        value: "user_name",
    }],
    web: {
        path: "/backend/users",
        vpcChannelId: vpcChannelId,
        requestMethod: "POST",
        requestProtocol: "HTTP",
        timeout: 5000,
    },
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
group_id = config.require_object("groupId")
api_name = config.require_object("apiName")
custom_response_id = config.require_object("customResponseId")
custom_auth_id = config.require_object("customAuthId")
vpc_channel_id = config.require_object("vpcChannelId")
test = flexibleengine.ApigApi("test",
    instance_id=instance_id,
    group_id=group_id,
    type="Public",
    request_protocol="HTTP",
    request_method="POST",
    request_path="/terraform/users",
    security_authentication="AUTHORIZER",
    matching="Exact",
    success_response="Successful",
    response_id=custom_response_id,
    authorizer_id=custom_auth_id,
    backend_params=[{
        "type": "SYSTEM",
        "name": "X-User-Auth",
        "location": "HEADER",
        "value": "user_name",
    }],
    web={
        "path": "/backend/users",
        "vpc_channel_id": vpc_channel_id,
        "request_method": "POST",
        "request_protocol": "HTTP",
        "timeout": 5000,
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		instanceId := cfg.RequireObject("instanceId")
		groupId := cfg.RequireObject("groupId")
		apiName := cfg.RequireObject("apiName")
		customResponseId := cfg.RequireObject("customResponseId")
		customAuthId := cfg.RequireObject("customAuthId")
		vpcChannelId := cfg.RequireObject("vpcChannelId")
		_, err := flexibleengine.NewApigApi(ctx, "test", &flexibleengine.ApigApiArgs{
			InstanceId:             pulumi.Any(instanceId),
			GroupId:                pulumi.Any(groupId),
			Type:                   pulumi.String("Public"),
			RequestProtocol:        pulumi.String("HTTP"),
			RequestMethod:          pulumi.String("POST"),
			RequestPath:            pulumi.String("/terraform/users"),
			SecurityAuthentication: pulumi.String("AUTHORIZER"),
			Matching:               pulumi.String("Exact"),
			SuccessResponse:        pulumi.String("Successful"),
			ResponseId:             pulumi.Any(customResponseId),
			AuthorizerId:           pulumi.Any(customAuthId),
			BackendParams: flexibleengine.ApigApiBackendParamArray{
				&flexibleengine.ApigApiBackendParamArgs{
					Type:     pulumi.String("SYSTEM"),
					Name:     pulumi.String("X-User-Auth"),
					Location: pulumi.String("HEADER"),
					Value:    pulumi.String("user_name"),
				},
			},
			Web: &flexibleengine.ApigApiWebArgs{
				Path:            pulumi.String("/backend/users"),
				VpcChannelId:    pulumi.Any(vpcChannelId),
				RequestMethod:   pulumi.String("POST"),
				RequestProtocol: pulumi.String("HTTP"),
				Timeout:         pulumi.Float64(5000),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var groupId = config.RequireObject<dynamic>("groupId");
    var apiName = config.RequireObject<dynamic>("apiName");
    var customResponseId = config.RequireObject<dynamic>("customResponseId");
    var customAuthId = config.RequireObject<dynamic>("customAuthId");
    var vpcChannelId = config.RequireObject<dynamic>("vpcChannelId");
    var test = new Flexibleengine.ApigApi("test", new()
    {
        InstanceId = instanceId,
        GroupId = groupId,
        Type = "Public",
        RequestProtocol = "HTTP",
        RequestMethod = "POST",
        RequestPath = "/terraform/users",
        SecurityAuthentication = "AUTHORIZER",
        Matching = "Exact",
        SuccessResponse = "Successful",
        ResponseId = customResponseId,
        AuthorizerId = customAuthId,
        BackendParams = new[]
        {
            new Flexibleengine.Inputs.ApigApiBackendParamArgs
            {
                Type = "SYSTEM",
                Name = "X-User-Auth",
                Location = "HEADER",
                Value = "user_name",
            },
        },
        Web = new Flexibleengine.Inputs.ApigApiWebArgs
        {
            Path = "/backend/users",
            VpcChannelId = vpcChannelId,
            RequestMethod = "POST",
            RequestProtocol = "HTTP",
            Timeout = 5000,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigApi;
import com.pulumi.flexibleengine.ApigApiArgs;
import com.pulumi.flexibleengine.inputs.ApigApiBackendParamArgs;
import com.pulumi.flexibleengine.inputs.ApigApiWebArgs;
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 config = ctx.config();
        final var instanceId = config.get("instanceId");
        final var groupId = config.get("groupId");
        final var apiName = config.get("apiName");
        final var customResponseId = config.get("customResponseId");
        final var customAuthId = config.get("customAuthId");
        final var vpcChannelId = config.get("vpcChannelId");
        var test = new ApigApi("test", ApigApiArgs.builder()
            .instanceId(instanceId)
            .groupId(groupId)
            .type("Public")
            .requestProtocol("HTTP")
            .requestMethod("POST")
            .requestPath("/terraform/users")
            .securityAuthentication("AUTHORIZER")
            .matching("Exact")
            .successResponse("Successful")
            .responseId(customResponseId)
            .authorizerId(customAuthId)
            .backendParams(ApigApiBackendParamArgs.builder()
                .type("SYSTEM")
                .name("X-User-Auth")
                .location("HEADER")
                .value("user_name")
                .build())
            .web(ApigApiWebArgs.builder()
                .path("/backend/users")
                .vpcChannelId(vpcChannelId)
                .requestMethod("POST")
                .requestProtocol("HTTP")
                .timeout(5000)
                .build())
            .build());

    }
}

    configuration:
  instanceId:
    type: dynamic
  groupId:
    type: dynamic
  apiName:
    type: dynamic
  customResponseId:
    type: dynamic
  customAuthId:
    type: dynamic
  vpcChannelId:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigApi
    properties:
      instanceId: ${instanceId}
      groupId: ${groupId}
      type: Public
      requestProtocol: HTTP
      requestMethod: POST
      requestPath: /terraform/users
      securityAuthentication: AUTHORIZER
      matching: Exact
      successResponse: Successful
      responseId: ${customResponseId}
      authorizerId: ${customAuthId}
      backendParams:
        - type: SYSTEM
          name: X-User-Auth
          location: HEADER
          value: user_name
      web:
        path: /backend/users
        vpcChannelId: ${vpcChannelId}
        requestMethod: POST
        requestProtocol: HTTP
        timeout: 5000

    Create ApigApi Resource

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

    Constructor syntax

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

@overload
def ApigApi(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            group_id: Optional[str] = None,
            type: Optional[str] = None,
            request_protocol: Optional[str] = None,
            request_path: Optional[str] = None,
            request_method: Optional[str] = None,
            instance_id: Optional[str] = None,
            failure_response: Optional[str] = None,
            request_params: Optional[Sequence[ApigApiRequestParamArgs]] = None,
            func_graph_policies: Optional[Sequence[ApigApiFuncGraphPolicyArgs]] = None,
            apig_api_id: Optional[str] = None,
            description: Optional[str] = None,
            matching: Optional[str] = None,
            mock: Optional[ApigApiMockArgs] = None,
            mock_policies: Optional[Sequence[ApigApiMockPolicyArgs]] = None,
            name: Optional[str] = None,
            region: Optional[str] = None,
            cors: Optional[bool] = None,
            func_graph: Optional[ApigApiFuncGraphArgs] = None,
            body_description: Optional[str] = None,
            backend_params: Optional[Sequence[ApigApiBackendParamArgs]] = None,
            response_id: Optional[str] = None,
            security_authentication: Optional[str] = None,
            simple_authentication: Optional[bool] = None,
            success_response: Optional[str] = None,
            authorizer_id: Optional[str] = None,
            web: Optional[ApigApiWebArgs] = None,
            web_policies: Optional[Sequence[ApigApiWebPolicyArgs]] = None)
    func NewApigApi(ctx *Context, name string, args ApigApiArgs, opts ...ResourceOption) (*ApigApi, error)
    public ApigApi(string name, ApigApiArgs args, CustomResourceOptions? opts = null)
    public ApigApi(String name, ApigApiArgs args)
public ApigApi(String name, ApigApiArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigApi
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 ApigApiArgs
    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 ApigApiArgs
    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 ApigApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigApiArgs
    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 apigApiResource = new Flexibleengine.ApigApi("apigApiResource", new()
{
    GroupId = "string",
    Type = "string",
    RequestProtocol = "string",
    RequestPath = "string",
    RequestMethod = "string",
    InstanceId = "string",
    FailureResponse = "string",
    RequestParams = new[]
    {
        new Flexibleengine.Inputs.ApigApiRequestParamArgs
        {
            Name = "string",
            Default = "string",
            Description = "string",
            Enumeration = "string",
            Example = "string",
            Location = "string",
            Maximum = 0,
            Minimum = 0,
            Passthrough = false,
            Required = false,
            Type = "string",
        },
    },
    FuncGraphPolicies = new[]
    {
        new Flexibleengine.Inputs.ApigApiFuncGraphPolicyArgs
        {
            Conditions = new[]
            {
                new Flexibleengine.Inputs.ApigApiFuncGraphPolicyConditionArgs
                {
                    Value = "string",
                    ParamName = "string",
                    Source = "string",
                    Type = "string",
                },
            },
            FunctionUrn = "string",
            Name = "string",
            AuthorizerId = "string",
            BackendParams = new[]
            {
                new Flexibleengine.Inputs.ApigApiFuncGraphPolicyBackendParamArgs
                {
                    Location = "string",
                    Name = "string",
                    Type = "string",
                    Value = "string",
                    Description = "string",
                    SystemParamType = "string",
                },
            },
            EffectiveMode = "string",
            InvocationMode = "string",
            Timeout = 0,
            Version = "string",
        },
    },
    ApigApiId = "string",
    Description = "string",
    Matching = "string",
    Mock = new Flexibleengine.Inputs.ApigApiMockArgs
    {
        AuthorizerId = "string",
        Response = "string",
    },
    MockPolicies = new[]
    {
        new Flexibleengine.Inputs.ApigApiMockPolicyArgs
        {
            Conditions = new[]
            {
                new Flexibleengine.Inputs.ApigApiMockPolicyConditionArgs
                {
                    Value = "string",
                    ParamName = "string",
                    Source = "string",
                    Type = "string",
                },
            },
            Name = "string",
            AuthorizerId = "string",
            BackendParams = new[]
            {
                new Flexibleengine.Inputs.ApigApiMockPolicyBackendParamArgs
                {
                    Location = "string",
                    Name = "string",
                    Type = "string",
                    Value = "string",
                    Description = "string",
                    SystemParamType = "string",
                },
            },
            EffectiveMode = "string",
            Response = "string",
        },
    },
    Name = "string",
    Region = "string",
    Cors = false,
    FuncGraph = new Flexibleengine.Inputs.ApigApiFuncGraphArgs
    {
        FunctionUrn = "string",
        AuthorizerId = "string",
        InvocationType = "string",
        Timeout = 0,
        Version = "string",
    },
    BodyDescription = "string",
    BackendParams = new[]
    {
        new Flexibleengine.Inputs.ApigApiBackendParamArgs
        {
            Location = "string",
            Name = "string",
            Type = "string",
            Value = "string",
            Description = "string",
            SystemParamType = "string",
        },
    },
    ResponseId = "string",
    SecurityAuthentication = "string",
    SimpleAuthentication = false,
    SuccessResponse = "string",
    AuthorizerId = "string",
    Web = new Flexibleengine.Inputs.ApigApiWebArgs
    {
        Path = "string",
        AuthorizerId = "string",
        BackendAddress = "string",
        HostHeader = "string",
        RequestMethod = "string",
        RequestProtocol = "string",
        RetryCount = 0,
        SslEnable = false,
        Timeout = 0,
        VpcChannelId = "string",
    },
    WebPolicies = new[]
    {
        new Flexibleengine.Inputs.ApigApiWebPolicyArgs
        {
            Name = "string",
            Conditions = new[]
            {
                new Flexibleengine.Inputs.ApigApiWebPolicyConditionArgs
                {
                    Value = "string",
                    ParamName = "string",
                    Source = "string",
                    Type = "string",
                },
            },
            Path = "string",
            RequestMethod = "string",
            BackendAddress = "string",
            BackendParams = new[]
            {
                new Flexibleengine.Inputs.ApigApiWebPolicyBackendParamArgs
                {
                    Location = "string",
                    Name = "string",
                    Type = "string",
                    Value = "string",
                    Description = "string",
                    SystemParamType = "string",
                },
            },
            EffectiveMode = "string",
            HostHeader = "string",
            AuthorizerId = "string",
            RequestProtocol = "string",
            RetryCount = 0,
            Timeout = 0,
            VpcChannelId = "string",
        },
    },
});

    example, err := flexibleengine.NewApigApi(ctx, "apigApiResource", &flexibleengine.ApigApiArgs{
	GroupId:         pulumi.String("string"),
	Type:            pulumi.String("string"),
	RequestProtocol: pulumi.String("string"),
	RequestPath:     pulumi.String("string"),
	RequestMethod:   pulumi.String("string"),
	InstanceId:      pulumi.String("string"),
	FailureResponse: pulumi.String("string"),
	RequestParams: flexibleengine.ApigApiRequestParamArray{
		&flexibleengine.ApigApiRequestParamArgs{
			Name:        pulumi.String("string"),
			Default:     pulumi.String("string"),
			Description: pulumi.String("string"),
			Enumeration: pulumi.String("string"),
			Example:     pulumi.String("string"),
			Location:    pulumi.String("string"),
			Maximum:     pulumi.Float64(0),
			Minimum:     pulumi.Float64(0),
			Passthrough: pulumi.Bool(false),
			Required:    pulumi.Bool(false),
			Type:        pulumi.String("string"),
		},
	},
	FuncGraphPolicies: flexibleengine.ApigApiFuncGraphPolicyArray{
		&flexibleengine.ApigApiFuncGraphPolicyArgs{
			Conditions: flexibleengine.ApigApiFuncGraphPolicyConditionArray{
				&flexibleengine.ApigApiFuncGraphPolicyConditionArgs{
					Value:     pulumi.String("string"),
					ParamName: pulumi.String("string"),
					Source:    pulumi.String("string"),
					Type:      pulumi.String("string"),
				},
			},
			FunctionUrn:  pulumi.String("string"),
			Name:         pulumi.String("string"),
			AuthorizerId: pulumi.String("string"),
			BackendParams: flexibleengine.ApigApiFuncGraphPolicyBackendParamArray{
				&flexibleengine.ApigApiFuncGraphPolicyBackendParamArgs{
					Location:        pulumi.String("string"),
					Name:            pulumi.String("string"),
					Type:            pulumi.String("string"),
					Value:           pulumi.String("string"),
					Description:     pulumi.String("string"),
					SystemParamType: pulumi.String("string"),
				},
			},
			EffectiveMode:  pulumi.String("string"),
			InvocationMode: pulumi.String("string"),
			Timeout:        pulumi.Float64(0),
			Version:        pulumi.String("string"),
		},
	},
	ApigApiId:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Matching:    pulumi.String("string"),
	Mock: &flexibleengine.ApigApiMockArgs{
		AuthorizerId: pulumi.String("string"),
		Response:     pulumi.String("string"),
	},
	MockPolicies: flexibleengine.ApigApiMockPolicyArray{
		&flexibleengine.ApigApiMockPolicyArgs{
			Conditions: flexibleengine.ApigApiMockPolicyConditionArray{
				&flexibleengine.ApigApiMockPolicyConditionArgs{
					Value:     pulumi.String("string"),
					ParamName: pulumi.String("string"),
					Source:    pulumi.String("string"),
					Type:      pulumi.String("string"),
				},
			},
			Name:         pulumi.String("string"),
			AuthorizerId: pulumi.String("string"),
			BackendParams: flexibleengine.ApigApiMockPolicyBackendParamArray{
				&flexibleengine.ApigApiMockPolicyBackendParamArgs{
					Location:        pulumi.String("string"),
					Name:            pulumi.String("string"),
					Type:            pulumi.String("string"),
					Value:           pulumi.String("string"),
					Description:     pulumi.String("string"),
					SystemParamType: pulumi.String("string"),
				},
			},
			EffectiveMode: pulumi.String("string"),
			Response:      pulumi.String("string"),
		},
	},
	Name:   pulumi.String("string"),
	Region: pulumi.String("string"),
	Cors:   pulumi.Bool(false),
	FuncGraph: &flexibleengine.ApigApiFuncGraphArgs{
		FunctionUrn:    pulumi.String("string"),
		AuthorizerId:   pulumi.String("string"),
		InvocationType: pulumi.String("string"),
		Timeout:        pulumi.Float64(0),
		Version:        pulumi.String("string"),
	},
	BodyDescription: pulumi.String("string"),
	BackendParams: flexibleengine.ApigApiBackendParamArray{
		&flexibleengine.ApigApiBackendParamArgs{
			Location:        pulumi.String("string"),
			Name:            pulumi.String("string"),
			Type:            pulumi.String("string"),
			Value:           pulumi.String("string"),
			Description:     pulumi.String("string"),
			SystemParamType: pulumi.String("string"),
		},
	},
	ResponseId:             pulumi.String("string"),
	SecurityAuthentication: pulumi.String("string"),
	SimpleAuthentication:   pulumi.Bool(false),
	SuccessResponse:        pulumi.String("string"),
	AuthorizerId:           pulumi.String("string"),
	Web: &flexibleengine.ApigApiWebArgs{
		Path:            pulumi.String("string"),
		AuthorizerId:    pulumi.String("string"),
		BackendAddress:  pulumi.String("string"),
		HostHeader:      pulumi.String("string"),
		RequestMethod:   pulumi.String("string"),
		RequestProtocol: pulumi.String("string"),
		RetryCount:      pulumi.Float64(0),
		SslEnable:       pulumi.Bool(false),
		Timeout:         pulumi.Float64(0),
		VpcChannelId:    pulumi.String("string"),
	},
	WebPolicies: flexibleengine.ApigApiWebPolicyArray{
		&flexibleengine.ApigApiWebPolicyArgs{
			Name: pulumi.String("string"),
			Conditions: flexibleengine.ApigApiWebPolicyConditionArray{
				&flexibleengine.ApigApiWebPolicyConditionArgs{
					Value:     pulumi.String("string"),
					ParamName: pulumi.String("string"),
					Source:    pulumi.String("string"),
					Type:      pulumi.String("string"),
				},
			},
			Path:           pulumi.String("string"),
			RequestMethod:  pulumi.String("string"),
			BackendAddress: pulumi.String("string"),
			BackendParams: flexibleengine.ApigApiWebPolicyBackendParamArray{
				&flexibleengine.ApigApiWebPolicyBackendParamArgs{
					Location:        pulumi.String("string"),
					Name:            pulumi.String("string"),
					Type:            pulumi.String("string"),
					Value:           pulumi.String("string"),
					Description:     pulumi.String("string"),
					SystemParamType: pulumi.String("string"),
				},
			},
			EffectiveMode:   pulumi.String("string"),
			HostHeader:      pulumi.String("string"),
			AuthorizerId:    pulumi.String("string"),
			RequestProtocol: pulumi.String("string"),
			RetryCount:      pulumi.Float64(0),
			Timeout:         pulumi.Float64(0),
			VpcChannelId:    pulumi.String("string"),
		},
	},
})

    var apigApiResource = new ApigApi("apigApiResource", ApigApiArgs.builder()
    .groupId("string")
    .type("string")
    .requestProtocol("string")
    .requestPath("string")
    .requestMethod("string")
    .instanceId("string")
    .failureResponse("string")
    .requestParams(ApigApiRequestParamArgs.builder()
        .name("string")
        .default_("string")
        .description("string")
        .enumeration("string")
        .example("string")
        .location("string")
        .maximum(0)
        .minimum(0)
        .passthrough(false)
        .required(false)
        .type("string")
        .build())
    .funcGraphPolicies(ApigApiFuncGraphPolicyArgs.builder()
        .conditions(ApigApiFuncGraphPolicyConditionArgs.builder()
            .value("string")
            .paramName("string")
            .source("string")
            .type("string")
            .build())
        .functionUrn("string")
        .name("string")
        .authorizerId("string")
        .backendParams(ApigApiFuncGraphPolicyBackendParamArgs.builder()
            .location("string")
            .name("string")
            .type("string")
            .value("string")
            .description("string")
            .systemParamType("string")
            .build())
        .effectiveMode("string")
        .invocationMode("string")
        .timeout(0)
        .version("string")
        .build())
    .apigApiId("string")
    .description("string")
    .matching("string")
    .mock(ApigApiMockArgs.builder()
        .authorizerId("string")
        .response("string")
        .build())
    .mockPolicies(ApigApiMockPolicyArgs.builder()
        .conditions(ApigApiMockPolicyConditionArgs.builder()
            .value("string")
            .paramName("string")
            .source("string")
            .type("string")
            .build())
        .name("string")
        .authorizerId("string")
        .backendParams(ApigApiMockPolicyBackendParamArgs.builder()
            .location("string")
            .name("string")
            .type("string")
            .value("string")
            .description("string")
            .systemParamType("string")
            .build())
        .effectiveMode("string")
        .response("string")
        .build())
    .name("string")
    .region("string")
    .cors(false)
    .funcGraph(ApigApiFuncGraphArgs.builder()
        .functionUrn("string")
        .authorizerId("string")
        .invocationType("string")
        .timeout(0)
        .version("string")
        .build())
    .bodyDescription("string")
    .backendParams(ApigApiBackendParamArgs.builder()
        .location("string")
        .name("string")
        .type("string")
        .value("string")
        .description("string")
        .systemParamType("string")
        .build())
    .responseId("string")
    .securityAuthentication("string")
    .simpleAuthentication(false)
    .successResponse("string")
    .authorizerId("string")
    .web(ApigApiWebArgs.builder()
        .path("string")
        .authorizerId("string")
        .backendAddress("string")
        .hostHeader("string")
        .requestMethod("string")
        .requestProtocol("string")
        .retryCount(0)
        .sslEnable(false)
        .timeout(0)
        .vpcChannelId("string")
        .build())
    .webPolicies(ApigApiWebPolicyArgs.builder()
        .name("string")
        .conditions(ApigApiWebPolicyConditionArgs.builder()
            .value("string")
            .paramName("string")
            .source("string")
            .type("string")
            .build())
        .path("string")
        .requestMethod("string")
        .backendAddress("string")
        .backendParams(ApigApiWebPolicyBackendParamArgs.builder()
            .location("string")
            .name("string")
            .type("string")
            .value("string")
            .description("string")
            .systemParamType("string")
            .build())
        .effectiveMode("string")
        .hostHeader("string")
        .authorizerId("string")
        .requestProtocol("string")
        .retryCount(0)
        .timeout(0)
        .vpcChannelId("string")
        .build())
    .build());

    apig_api_resource = flexibleengine.ApigApi("apigApiResource",
    group_id="string",
    type="string",
    request_protocol="string",
    request_path="string",
    request_method="string",
    instance_id="string",
    failure_response="string",
    request_params=[{
        "name": "string",
        "default": "string",
        "description": "string",
        "enumeration": "string",
        "example": "string",
        "location": "string",
        "maximum": 0,
        "minimum": 0,
        "passthrough": False,
        "required": False,
        "type": "string",
    }],
    func_graph_policies=[{
        "conditions": [{
            "value": "string",
            "param_name": "string",
            "source": "string",
            "type": "string",
        }],
        "function_urn": "string",
        "name": "string",
        "authorizer_id": "string",
        "backend_params": [{
            "location": "string",
            "name": "string",
            "type": "string",
            "value": "string",
            "description": "string",
            "system_param_type": "string",
        }],
        "effective_mode": "string",
        "invocation_mode": "string",
        "timeout": 0,
        "version": "string",
    }],
    apig_api_id="string",
    description="string",
    matching="string",
    mock={
        "authorizer_id": "string",
        "response": "string",
    },
    mock_policies=[{
        "conditions": [{
            "value": "string",
            "param_name": "string",
            "source": "string",
            "type": "string",
        }],
        "name": "string",
        "authorizer_id": "string",
        "backend_params": [{
            "location": "string",
            "name": "string",
            "type": "string",
            "value": "string",
            "description": "string",
            "system_param_type": "string",
        }],
        "effective_mode": "string",
        "response": "string",
    }],
    name="string",
    region="string",
    cors=False,
    func_graph={
        "function_urn": "string",
        "authorizer_id": "string",
        "invocation_type": "string",
        "timeout": 0,
        "version": "string",
    },
    body_description="string",
    backend_params=[{
        "location": "string",
        "name": "string",
        "type": "string",
        "value": "string",
        "description": "string",
        "system_param_type": "string",
    }],
    response_id="string",
    security_authentication="string",
    simple_authentication=False,
    success_response="string",
    authorizer_id="string",
    web={
        "path": "string",
        "authorizer_id": "string",
        "backend_address": "string",
        "host_header": "string",
        "request_method": "string",
        "request_protocol": "string",
        "retry_count": 0,
        "ssl_enable": False,
        "timeout": 0,
        "vpc_channel_id": "string",
    },
    web_policies=[{
        "name": "string",
        "conditions": [{
            "value": "string",
            "param_name": "string",
            "source": "string",
            "type": "string",
        }],
        "path": "string",
        "request_method": "string",
        "backend_address": "string",
        "backend_params": [{
            "location": "string",
            "name": "string",
            "type": "string",
            "value": "string",
            "description": "string",
            "system_param_type": "string",
        }],
        "effective_mode": "string",
        "host_header": "string",
        "authorizer_id": "string",
        "request_protocol": "string",
        "retry_count": 0,
        "timeout": 0,
        "vpc_channel_id": "string",
    }])

    const apigApiResource = new flexibleengine.ApigApi("apigApiResource", {
    groupId: "string",
    type: "string",
    requestProtocol: "string",
    requestPath: "string",
    requestMethod: "string",
    instanceId: "string",
    failureResponse: "string",
    requestParams: [{
        name: "string",
        "default": "string",
        description: "string",
        enumeration: "string",
        example: "string",
        location: "string",
        maximum: 0,
        minimum: 0,
        passthrough: false,
        required: false,
        type: "string",
    }],
    funcGraphPolicies: [{
        conditions: [{
            value: "string",
            paramName: "string",
            source: "string",
            type: "string",
        }],
        functionUrn: "string",
        name: "string",
        authorizerId: "string",
        backendParams: [{
            location: "string",
            name: "string",
            type: "string",
            value: "string",
            description: "string",
            systemParamType: "string",
        }],
        effectiveMode: "string",
        invocationMode: "string",
        timeout: 0,
        version: "string",
    }],
    apigApiId: "string",
    description: "string",
    matching: "string",
    mock: {
        authorizerId: "string",
        response: "string",
    },
    mockPolicies: [{
        conditions: [{
            value: "string",
            paramName: "string",
            source: "string",
            type: "string",
        }],
        name: "string",
        authorizerId: "string",
        backendParams: [{
            location: "string",
            name: "string",
            type: "string",
            value: "string",
            description: "string",
            systemParamType: "string",
        }],
        effectiveMode: "string",
        response: "string",
    }],
    name: "string",
    region: "string",
    cors: false,
    funcGraph: {
        functionUrn: "string",
        authorizerId: "string",
        invocationType: "string",
        timeout: 0,
        version: "string",
    },
    bodyDescription: "string",
    backendParams: [{
        location: "string",
        name: "string",
        type: "string",
        value: "string",
        description: "string",
        systemParamType: "string",
    }],
    responseId: "string",
    securityAuthentication: "string",
    simpleAuthentication: false,
    successResponse: "string",
    authorizerId: "string",
    web: {
        path: "string",
        authorizerId: "string",
        backendAddress: "string",
        hostHeader: "string",
        requestMethod: "string",
        requestProtocol: "string",
        retryCount: 0,
        sslEnable: false,
        timeout: 0,
        vpcChannelId: "string",
    },
    webPolicies: [{
        name: "string",
        conditions: [{
            value: "string",
            paramName: "string",
            source: "string",
            type: "string",
        }],
        path: "string",
        requestMethod: "string",
        backendAddress: "string",
        backendParams: [{
            location: "string",
            name: "string",
            type: "string",
            value: "string",
            description: "string",
            systemParamType: "string",
        }],
        effectiveMode: "string",
        hostHeader: "string",
        authorizerId: "string",
        requestProtocol: "string",
        retryCount: 0,
        timeout: 0,
        vpcChannelId: "string",
    }],
});

    type: flexibleengine:ApigApi
properties:
    apigApiId: string
    authorizerId: string
    backendParams:
        - description: string
          location: string
          name: string
          systemParamType: string
          type: string
          value: string
    bodyDescription: string
    cors: false
    description: string
    failureResponse: string
    funcGraph:
        authorizerId: string
        functionUrn: string
        invocationType: string
        timeout: 0
        version: string
    funcGraphPolicies:
        - authorizerId: string
          backendParams:
            - description: string
              location: string
              name: string
              systemParamType: string
              type: string
              value: string
          conditions:
            - paramName: string
              source: string
              type: string
              value: string
          effectiveMode: string
          functionUrn: string
          invocationMode: string
          name: string
          timeout: 0
          version: string
    groupId: string
    instanceId: string
    matching: string
    mock:
        authorizerId: string
        response: string
    mockPolicies:
        - authorizerId: string
          backendParams:
            - description: string
              location: string
              name: string
              systemParamType: string
              type: string
              value: string
          conditions:
            - paramName: string
              source: string
              type: string
              value: string
          effectiveMode: string
          name: string
          response: string
    name: string
    region: string
    requestMethod: string
    requestParams:
        - default: string
          description: string
          enumeration: string
          example: string
          location: string
          maximum: 0
          minimum: 0
          name: string
          passthrough: false
          required: false
          type: string
    requestPath: string
    requestProtocol: string
    responseId: string
    securityAuthentication: string
    simpleAuthentication: false
    successResponse: string
    type: string
    web:
        authorizerId: string
        backendAddress: string
        hostHeader: string
        path: string
        requestMethod: string
        requestProtocol: string
        retryCount: 0
        sslEnable: false
        timeout: 0
        vpcChannelId: string
    webPolicies:
        - authorizerId: string
          backendAddress: string
          backendParams:
            - description: string
              location: string
              name: string
              systemParamType: string
              type: string
              value: string
          conditions:
            - paramName: string
              source: string
              type: string
              value: string
          effectiveMode: string
          hostHeader: string
          name: string
          path: string
          requestMethod: string
          requestProtocol: string
          retryCount: 0
          timeout: 0
          vpcChannelId: string

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

    GroupId string
    Specifies an ID of the APIG group to which the API belongs to.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    ApigApiId string
    ID of the APIG API.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams List<ApigApiBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    BodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Cors bool
    Specifies whether CORS is supported, default to false.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    FailureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    FuncGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    FuncGraphPolicies List<ApigApiFuncGraphPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    Mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    MockPolicies List<ApigApiMockPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    RequestParams List<ApigApiRequestParam>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    ResponseId string
    Specifies the APIG group response ID.
    SecurityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    SimpleAuthentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    SuccessResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    WebPolicies List<ApigApiWebPolicy>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    GroupId string
    Specifies an ID of the APIG group to which the API belongs to.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    ApigApiId string
    ID of the APIG API.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams []ApigApiBackendParamArgs
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    BodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Cors bool
    Specifies whether CORS is supported, default to false.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    FailureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    FuncGraph ApigApiFuncGraphArgs
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    FuncGraphPolicies []ApigApiFuncGraphPolicyArgs
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    Mock ApigApiMockArgs
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    MockPolicies []ApigApiMockPolicyArgs
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    RequestParams []ApigApiRequestParamArgs
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    ResponseId string
    Specifies the APIG group response ID.
    SecurityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    SimpleAuthentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    SuccessResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Web ApigApiWebArgs
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    WebPolicies []ApigApiWebPolicyArgs

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    groupId String
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestPath String
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    apigApiId String
    ID of the APIG API.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<ApigApiBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription String
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors Boolean
    Specifies whether CORS is supported, default to false.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies List<ApigApiFuncGraphPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    matching String
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies List<ApigApiMockPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    requestParams List<ApigApiRequestParam>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    responseId String
    Specifies the APIG group response ID.
    securityAuthentication String
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication Boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies List<ApigApiWebPolicy>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    groupId string
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    requestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    apigApiId string
    ID of the APIG API.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams ApigApiBackendParam[]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors boolean
    Specifies whether CORS is supported, default to false.
    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies ApigApiFuncGraphPolicy[]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies ApigApiMockPolicy[]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    requestParams ApigApiRequestParam[]
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    responseId string
    Specifies the APIG group response ID.
    securityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies ApigApiWebPolicy[]

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    group_id str
    Specifies an ID of the APIG group to which the API belongs to.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    request_method str
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    request_path str
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    request_protocol str
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    apig_api_id str
    ID of the APIG API.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_params Sequence[ApigApiBackendParamArgs]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    body_description str
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors bool
    Specifies whether CORS is supported, default to false.
    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failure_response str
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    func_graph ApigApiFuncGraphArgs
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    func_graph_policies Sequence[ApigApiFuncGraphPolicyArgs]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    matching str
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMockArgs
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mock_policies Sequence[ApigApiMockPolicyArgs]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    request_params Sequence[ApigApiRequestParamArgs]
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    response_id str
    Specifies the APIG group response ID.
    security_authentication str
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simple_authentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    success_response str
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    web ApigApiWebArgs
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    web_policies Sequence[ApigApiWebPolicyArgs]

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    groupId String
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestPath String
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    apigApiId String
    ID of the APIG API.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<Property Map>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription String
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors Boolean
    Specifies whether CORS is supported, default to false.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph Property Map
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies List<Property Map>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    matching String
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock Property Map
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies List<Property Map>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    requestParams List<Property Map>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    responseId String
    Specifies the APIG group response ID.
    securityAuthentication String
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication Boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    web Property Map
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies List<Property Map>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    RegisteredAt string
    Time when the API is registered, in UTC format.
    UpdatedAt string
    Time when the API was last modified, in UTC format.
    Id string
    The provider-assigned unique ID for this managed resource.
    RegisteredAt string
    Time when the API is registered, in UTC format.
    UpdatedAt string
    Time when the API was last modified, in UTC format.
    id String
    The provider-assigned unique ID for this managed resource.
    registeredAt String
    Time when the API is registered, in UTC format.
    updatedAt String
    Time when the API was last modified, in UTC format.
    id string
    The provider-assigned unique ID for this managed resource.
    registeredAt string
    Time when the API is registered, in UTC format.
    updatedAt string
    Time when the API was last modified, in UTC format.
    id str
    The provider-assigned unique ID for this managed resource.
    registered_at str
    Time when the API is registered, in UTC format.
    updated_at str
    Time when the API was last modified, in UTC format.
    id String
    The provider-assigned unique ID for this managed resource.
    registeredAt String
    Time when the API is registered, in UTC format.
    updatedAt String
    Time when the API was last modified, in UTC format.

    Look up Existing ApigApi Resource

    Get an existing ApigApi 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?: ApigApiState, opts?: CustomResourceOptions): ApigApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_api_id: Optional[str] = None,
        authorizer_id: Optional[str] = None,
        backend_params: Optional[Sequence[ApigApiBackendParamArgs]] = None,
        body_description: Optional[str] = None,
        cors: Optional[bool] = None,
        description: Optional[str] = None,
        failure_response: Optional[str] = None,
        func_graph: Optional[ApigApiFuncGraphArgs] = None,
        func_graph_policies: Optional[Sequence[ApigApiFuncGraphPolicyArgs]] = None,
        group_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        matching: Optional[str] = None,
        mock: Optional[ApigApiMockArgs] = None,
        mock_policies: Optional[Sequence[ApigApiMockPolicyArgs]] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        registered_at: Optional[str] = None,
        request_method: Optional[str] = None,
        request_params: Optional[Sequence[ApigApiRequestParamArgs]] = None,
        request_path: Optional[str] = None,
        request_protocol: Optional[str] = None,
        response_id: Optional[str] = None,
        security_authentication: Optional[str] = None,
        simple_authentication: Optional[bool] = None,
        success_response: Optional[str] = None,
        type: Optional[str] = None,
        updated_at: Optional[str] = None,
        web: Optional[ApigApiWebArgs] = None,
        web_policies: Optional[Sequence[ApigApiWebPolicyArgs]] = None) -> ApigApi
    func GetApigApi(ctx *Context, name string, id IDInput, state *ApigApiState, opts ...ResourceOption) (*ApigApi, error)
    public static ApigApi Get(string name, Input<string> id, ApigApiState? state, CustomResourceOptions? opts = null)
    public static ApigApi get(String name, Output<String> id, ApigApiState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigApi    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:
    ApigApiId string
    ID of the APIG API.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams List<ApigApiBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    BodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Cors bool
    Specifies whether CORS is supported, default to false.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    FailureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    FuncGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    FuncGraphPolicies List<ApigApiFuncGraphPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    GroupId string
    Specifies an ID of the APIG group to which the API belongs to.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    Matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    Mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    MockPolicies List<ApigApiMockPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    RegisteredAt string
    Time when the API is registered, in UTC format.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestParams List<ApigApiRequestParam>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    RequestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    ResponseId string
    Specifies the APIG group response ID.
    SecurityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    SimpleAuthentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    SuccessResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    UpdatedAt string
    Time when the API was last modified, in UTC format.
    Web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    WebPolicies List<ApigApiWebPolicy>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    ApigApiId string
    ID of the APIG API.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams []ApigApiBackendParamArgs
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    BodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Cors bool
    Specifies whether CORS is supported, default to false.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    FailureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    FuncGraph ApigApiFuncGraphArgs
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    FuncGraphPolicies []ApigApiFuncGraphPolicyArgs
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    GroupId string
    Specifies an ID of the APIG group to which the API belongs to.
    InstanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    Matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    Mock ApigApiMockArgs
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    MockPolicies []ApigApiMockPolicyArgs
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    RegisteredAt string
    Time when the API is registered, in UTC format.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestParams []ApigApiRequestParamArgs
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    RequestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    ResponseId string
    Specifies the APIG group response ID.
    SecurityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    SimpleAuthentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    SuccessResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    UpdatedAt string
    Time when the API was last modified, in UTC format.
    Web ApigApiWebArgs
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    WebPolicies []ApigApiWebPolicyArgs

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    apigApiId String
    ID of the APIG API.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<ApigApiBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription String
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors Boolean
    Specifies whether CORS is supported, default to false.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies List<ApigApiFuncGraphPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    groupId String
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    matching String
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies List<ApigApiMockPolicy>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    registeredAt String
    Time when the API is registered, in UTC format.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestParams List<ApigApiRequestParam>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    requestPath String
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    responseId String
    Specifies the APIG group response ID.
    securityAuthentication String
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication Boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    updatedAt String
    Time when the API was last modified, in UTC format.
    web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies List<ApigApiWebPolicy>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    apigApiId string
    ID of the APIG API.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams ApigApiBackendParam[]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription string
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors boolean
    Specifies whether CORS is supported, default to false.
    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph ApigApiFuncGraph
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies ApigApiFuncGraphPolicy[]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    groupId string
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId string
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    matching string
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMock
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies ApigApiMockPolicy[]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    registeredAt string
    Time when the API is registered, in UTC format.
    requestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestParams ApigApiRequestParam[]
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    requestPath string
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    responseId string
    Specifies the APIG group response ID.
    securityAuthentication string
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse string
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    updatedAt string
    Time when the API was last modified, in UTC format.
    web ApigApiWeb
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies ApigApiWebPolicy[]

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    apig_api_id str
    ID of the APIG API.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_params Sequence[ApigApiBackendParamArgs]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    body_description str
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors bool
    Specifies whether CORS is supported, default to false.
    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failure_response str
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    func_graph ApigApiFuncGraphArgs
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    func_graph_policies Sequence[ApigApiFuncGraphPolicyArgs]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    group_id str
    Specifies an ID of the APIG group to which the API belongs to.
    instance_id str
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    matching str
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock ApigApiMockArgs
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mock_policies Sequence[ApigApiMockPolicyArgs]
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    registered_at str
    Time when the API is registered, in UTC format.
    request_method str
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    request_params Sequence[ApigApiRequestParamArgs]
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    request_path str
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    request_protocol str
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    response_id str
    Specifies the APIG group response ID.
    security_authentication str
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simple_authentication bool
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    success_response str
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    updated_at str
    Time when the API was last modified, in UTC format.
    web ApigApiWebArgs
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    web_policies Sequence[ApigApiWebPolicyArgs]

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    apigApiId String
    ID of the APIG API.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<Property Map>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    bodyDescription String
    Specifies the description of the API request body, which can be an example request body, media type or parameters. The request body does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    cors Boolean
    Specifies whether CORS is supported, default to false.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    failureResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    funcGraph Property Map
    Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
    funcGraphPolicies List<Property Map>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    groupId String
    Specifies an ID of the APIG group to which the API belongs to.
    instanceId String
    Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
    matching String
    Specifies the route matching mode. The valid value are Exact and Prefix, default to Exact.
    mock Property Map
    Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
    mockPolicies List<Property Map>
    Specifies the Mock policy backends. The maximum of the policy is 5. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the API resource. If omitted, the provider-level region will be used. Changing this will create a new API resource.
    registeredAt String
    Time when the API is registered, in UTC format.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestParams List<Property Map>
    Specifies an array of one or more request parameters of the front-end. The maximum of request parameters is 50. The object structure is documented below.
    requestPath String
    Specifies the request address, which can contain a maximum of 512 characters request parameters enclosed with brackets ({}).

    • The address can contain special characters, such as asterisks (), percent signs (%), hyphens (-), and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    responseId String
    Specifies the APIG group response ID.
    securityAuthentication String
    Specifies the security authentication mode. The valid values are NONE, APP and IAM, default to NONE.
    simpleAuthentication Boolean
    Specifies whether AppCode authentication is enabled. The applicaiton code must located in the header when simple_authentication is true.
    successResponse String
    Specifies the example response for a successful request. Ensure that the response does not exceed 20,480 characters. Chinese characters must be in UTF-8 or Unicode format.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    updatedAt String
    Time when the API was last modified, in UTC format.
    web Property Map
    Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
    webPolicies List<Property Map>

    Specifies the example response for a failed request. The maximum of the policy is 5. The object structure is documented below.

    The request_params block supports:

    Supporting Types

    ApigApiBackendParam, ApigApiBackendParamArgs

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location str
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    system_param_type str

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    ApigApiFuncGraph, ApigApiFuncGraphArgs

    FunctionUrn string
    Specifies the URN of the function graph.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    InvocationType string
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    Timeout double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    Version string
    Specifies the version of the function graph.
    FunctionUrn string
    Specifies the URN of the function graph.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    InvocationType string
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    Timeout float64
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    Version string
    Specifies the version of the function graph.
    functionUrn String
    Specifies the URN of the function graph.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    invocationType String
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    timeout Double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version String
    Specifies the version of the function graph.
    functionUrn string
    Specifies the URN of the function graph.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    invocationType string
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    timeout number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version string
    Specifies the version of the function graph.
    function_urn str
    Specifies the URN of the function graph.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    invocation_type str
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    timeout float
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version str
    Specifies the version of the function graph.
    functionUrn String
    Specifies the URN of the function graph.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    invocationType String
    Specifies the invocation mode. The valid values are async and sync, default to sync.
    timeout Number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version String
    Specifies the version of the function graph.

    ApigApiFuncGraphPolicy, ApigApiFuncGraphPolicyArgs

    Conditions List<ApigApiFuncGraphPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    FunctionUrn string
    Specifies the URN of the function graph.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams List<ApigApiFuncGraphPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    InvocationMode string
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    Timeout double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    Version string
    Specifies the version of the function graph.
    Conditions []ApigApiFuncGraphPolicyCondition
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    FunctionUrn string
    Specifies the URN of the function graph.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams []ApigApiFuncGraphPolicyBackendParam
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    InvocationMode string
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    Timeout float64
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    Version string
    Specifies the version of the function graph.
    conditions List<ApigApiFuncGraphPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    functionUrn String
    Specifies the URN of the function graph.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<ApigApiFuncGraphPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    invocationMode String
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    timeout Double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version String
    Specifies the version of the function graph.
    conditions ApigApiFuncGraphPolicyCondition[]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    functionUrn string
    Specifies the URN of the function graph.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams ApigApiFuncGraphPolicyBackendParam[]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    invocationMode string
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    timeout number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version string
    Specifies the version of the function graph.
    conditions Sequence[ApigApiFuncGraphPolicyCondition]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    function_urn str
    Specifies the URN of the function graph.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_params Sequence[ApigApiFuncGraphPolicyBackendParam]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effective_mode str
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    invocation_mode str
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    timeout float
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version str
    Specifies the version of the function graph.
    conditions List<Property Map>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    functionUrn String
    Specifies the URN of the function graph.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<Property Map>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    invocationMode String
    Specifies the invocation mode of the function graph. The valid values are async and sync, default to sync.
    timeout Number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    version String
    Specifies the version of the function graph.

    ApigApiFuncGraphPolicyBackendParam, ApigApiFuncGraphPolicyBackendParamArgs

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location str
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    system_param_type str

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    ApigApiFuncGraphPolicyCondition, ApigApiFuncGraphPolicyConditionArgs

    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source string
    Specifies the policy type. The valid values are param and source, default to source.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    param_name str
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source str
    Specifies the policy type. The valid values are param and source, default to source.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.

    ApigApiMock, ApigApiMockArgs

    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    Response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    Response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    response String
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    response str
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    response String
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.

    ApigApiMockPolicy, ApigApiMockPolicyArgs

    Conditions List<ApigApiMockPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams List<ApigApiMockPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    Response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    Conditions []ApigApiMockPolicyCondition
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendParams []ApigApiMockPolicyBackendParam
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    Response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    conditions List<ApigApiMockPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<ApigApiMockPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    response String
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    conditions ApigApiMockPolicyCondition[]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams ApigApiMockPolicyBackendParam[]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    response string
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    conditions Sequence[ApigApiMockPolicyCondition]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_params Sequence[ApigApiMockPolicyBackendParam]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effective_mode str
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    response str
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.
    conditions List<Property Map>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendParams List<Property Map>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    response String
    Specifies the response of the backend policy, which contain a maximum of 2,048 characters, and the angle brackets (< and >) are not allowed.

    ApigApiMockPolicyBackendParam, ApigApiMockPolicyBackendParamArgs

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location str
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    system_param_type str

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    ApigApiMockPolicyCondition, ApigApiMockPolicyConditionArgs

    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source string
    Specifies the policy type. The valid values are param and source, default to source.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    param_name str
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source str
    Specifies the policy type. The valid values are param and source, default to source.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.

    ApigApiRequestParam, ApigApiRequestParamArgs

    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Default string
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Enumeration string
    The enumerated value.
    Example string
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Maximum double
    Specifies the maximum value or size of the request parameter.
    Minimum double
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    Passthrough bool
    Whether to transparently transfer the parameter.
    Required bool
    Specifies whether the request parameter is required.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Default string
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Enumeration string
    The enumerated value.
    Example string
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Maximum float64
    Specifies the maximum value or size of the request parameter.
    Minimum float64
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    Passthrough bool
    Whether to transparently transfer the parameter.
    Required bool
    Specifies whether the request parameter is required.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    default_ String
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    enumeration String
    The enumerated value.
    example String
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    maximum Double
    Specifies the maximum value or size of the request parameter.
    minimum Double
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    passthrough Boolean
    Whether to transparently transfer the parameter.
    required Boolean
    Specifies whether the request parameter is required.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    default string
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    enumeration string
    The enumerated value.
    example string
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    maximum number
    Specifies the maximum value or size of the request parameter.
    minimum number
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    passthrough boolean
    Whether to transparently transfer the parameter.
    required boolean
    Specifies whether the request parameter is required.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    default str
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    enumeration str
    The enumerated value.
    example str
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    location str
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    maximum float
    Specifies the maximum value or size of the request parameter.
    minimum float
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    passthrough bool
    Whether to transparently transfer the parameter.
    required bool
    Specifies whether the request parameter is required.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    default String
    Specifies the default value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    enumeration String
    The enumerated value.
    example String
    Specifies the example value of the request parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    maximum Number
    Specifies the maximum value or size of the request parameter.
    minimum Number
    Specifies the minimum value or size of the request parameter. For string type, The maximum and minimum means size. For number type, they means value.
    passthrough Boolean
    Whether to transparently transfer the parameter.
    required Boolean
    Specifies whether the request parameter is required.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.

    ApigApiWeb, ApigApiWebArgs

    Path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    HostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    RetryCount double
    The number of retry attempts to request the backend service.
    SslEnable bool
    Specifies the indicates whether to enable two-way authentication, default to false.
    Timeout double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    VpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    Path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    HostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    RetryCount float64
    The number of retry attempts to request the backend service.
    SslEnable bool
    Specifies the indicates whether to enable two-way authentication, default to false.
    Timeout float64
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    VpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    path String
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress String
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    hostHeader String
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount Double
    The number of retry attempts to request the backend service.
    sslEnable Boolean
    Specifies the indicates whether to enable two-way authentication, default to false.
    timeout Double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId String
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    hostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount number
    The number of retry attempts to request the backend service.
    sslEnable boolean
    Specifies the indicates whether to enable two-way authentication, default to false.
    timeout number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    path str
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_address str
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    host_header str
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    request_method str
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    request_protocol str
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retry_count float
    The number of retry attempts to request the backend service.
    ssl_enable bool
    Specifies the indicates whether to enable two-way authentication, default to false.
    timeout float
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpc_channel_id str
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    path String
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress String
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    hostHeader String
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount Number
    The number of retry attempts to request the backend service.
    sslEnable Boolean
    Specifies the indicates whether to enable two-way authentication, default to false.
    timeout Number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId String
    Specifies the VPC channel ID. This parameter and backend_address are alternative.

    ApigApiWebPolicy, ApigApiWebPolicyArgs

    Conditions List<ApigApiWebPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    BackendParams List<ApigApiWebPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    HostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    RetryCount double
    The number of retry attempts to request the backend service.
    Timeout double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    VpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    Conditions []ApigApiWebPolicyCondition
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    RequestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    AuthorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    BackendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    BackendParams []ApigApiWebPolicyBackendParam
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    EffectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    HostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    RequestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    RetryCount float64
    The number of retry attempts to request the backend service.
    Timeout float64
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    VpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    conditions List<ApigApiWebPolicyCondition>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    path String
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress String
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    backendParams List<ApigApiWebPolicyBackendParam>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    hostHeader String
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount Double
    The number of retry attempts to request the backend service.
    timeout Double
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId String
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    conditions ApigApiWebPolicyCondition[]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    path string
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestMethod string
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    authorizerId string

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress string
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    backendParams ApigApiWebPolicyBackendParam[]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode string
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    hostHeader string
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestProtocol string
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount number
    The number of retry attempts to request the backend service.
    timeout number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId string
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    conditions Sequence[ApigApiWebPolicyCondition]
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    path str
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    request_method str
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    authorizer_id str

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backend_address str
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    backend_params Sequence[ApigApiWebPolicyBackendParam]
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effective_mode str
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    host_header str
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    request_protocol str
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retry_count float
    The number of retry attempts to request the backend service.
    timeout float
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpc_channel_id str
    Specifies the VPC channel ID. This parameter and backend_address are alternative.
    conditions List<Property Map>
    Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    path String
    Specifies the backend request address, which can contain a maximum of 512 characters and must comply with URI specifications.

    • The request address can contain request parameters enclosed with brackets ({}).
    • The request address can contain special characters, such as asterisks (*), percent signs (%), hyphens (-) and underscores (_) and must comply with URI specifications.
    • The address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
    requestMethod String
    Specifies the backend request method of the API. The valid types are GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS and ANY.
    authorizerId String

    Specifies the ID of the backend custom authorization.

    The conditions block supports:

    backendAddress String
    Specifies the backend service address, which consists of a domain name or IP address, and a port number, with not more than 255 characters. The backend service address must be in the format "Host name:Port number", for example, apig.example.com:7443. If the port number is not specified, the default HTTPS port 443 or the default HTTP port 80 is used. The backend service address can contain environment variables, each starting with a letter and consisting of 3 to 32 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.
    backendParams List<Property Map>
    Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
    effectiveMode String
    Specifies the effective mode of the backend policy. The valid values are ALL and ANY, default to ANY.
    hostHeader String
    Specifies the proxy host header. The host header can be customized for requests to be forwarded to cloud servers through the VPC channel. By default, the original host header of the request is used.
    requestProtocol String
    Specifies the backend request protocol. The valid values are HTTP and HTTPS, default to HTTPS.
    retryCount Number
    The number of retry attempts to request the backend service.
    timeout Number
    Specifies the timeout, in ms, which allowed for APIG to request the backend service. The valid value is range from 1 to 600,000, default to 5,000.
    vpcChannelId String
    Specifies the VPC channel ID. This parameter and backend_address are alternative.

    ApigApiWebPolicyBackendParam, ApigApiWebPolicyBackendParamArgs

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    Location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    Name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    Description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    SystemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location string
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name string
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description string
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType string

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location str
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name str
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description str
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    system_param_type str

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    location String
    Specifies the location of the backend parameter. The valid values are PATH, QUERY and HEADER.
    name String
    Specifies the backend policy name, which can contains of 3 to 64 characters and start with a letter. Only letters, digits, and underscores (_) are allowed.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    description String
    Specifies the description of the constant or system parameter, which contain a maximum of 255 characters, and the angle brackets (< and >) are not allowed.
    systemParamType String

    Specifies the type of the system parameter.
    The valid values are frontend, backend and internal, defaults to internal.

    The mock block supports:

    ApigApiWebPolicyCondition, ApigApiWebPolicyConditionArgs

    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    Value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    ParamName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    Source string
    Specifies the policy type. The valid values are param and source, default to source.
    Type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value string

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName string
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source string
    Specifies the policy type. The valid values are param and source, default to source.
    type string
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value str

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    param_name str
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source str
    Specifies the policy type. The valid values are param and source, default to source.
    type str
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.
    value String

    Specifies the condition type. For a condition with the input parameter source:

    • If the condition type is Enumerated, separate condition values with commas.
    • If the condition type is Matching, enter a regular expression compatible with PERL.

    For a condition with the Source IP address source, enter IPv4 addresses and separate them with commas. The CIDR address format is supported.

    paramName String
    Specifies the request parameter name. This parameter is required if the policy type is param.
    source String
    Specifies the policy type. The valid values are param and source, default to source.
    type String
    Specifies the condition type of the backend policy. The valid values are Equal, Enumerated and Matching, default to Equal.

    Import

    APIs can be imported using the ID of the APIG dedicated instance to which the API belongs and API name, separated by a

    slash, e.g.

    $ pulumi import flexibleengine:index/apigApi:ApigApi test <instance_id>/<name>

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine