Docs Home
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud.ApigwApiV2
Explore with Pulumi AI
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
Up-to-date reference of API arguments for API Gateway API service you can get at documentation portal
Provides an API gateway API resource.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";
const config = new pulumi.Config();
const vpcId = config.requireObject("vpcId");
const subnetId = config.requireObject("subnetId");
const secgroupId = config.requireObject("secgroupId");
const gateway = new opentelekomcloud.ApigwGatewayV2("gateway", {
specId: "BASIC",
vpcId: vpcId,
subnetId: subnetId,
securityGroupId: secgroupId,
availabilityZones: [
"eu-de-01",
"eu-de-02",
],
description: "test gateway 2",
ingressBandwidthSize: 5,
ingressBandwidthChargingMode: "bandwidth",
maintainBegin: "02:00:00",
});
const env = new opentelekomcloud.ApigwEnvironmentV2("env", {
instanceId: gateway.apigwGatewayV2Id,
description: "test description",
});
const group = new opentelekomcloud.ApigwGroupV2("group", {
instanceId: gateway.apigwGatewayV2Id,
description: "test description",
environments: [{
variables: [{
name: "test-name",
value: "test-value",
}],
environmentId: env.apigwEnvironmentV2Id,
}],
});
const api = new opentelekomcloud.ApigwApiV2("api", {
gatewayId: gateway.apigwGatewayV2Id,
groupId: group.apigwGroupV2Id,
type: "Public",
requestProtocol: "HTTP",
requestMethod: "GET",
requestUri: "/user_info/{user_age}",
securityAuthenticationType: "APP",
matchMode: "EXACT",
successResponse: "Success response",
failureResponse: "Failed response",
description: "Created by script",
requestParams: [
{
name: "user_age",
type: "NUMBER",
location: "PATH",
required: true,
maximum: 200,
minimum: 0,
},
{
name: "X-TEST-ENUM",
type: "STRING",
location: "HEADER",
maximum: 20,
minimum: 10,
sample: "ACC_TEST_XXX",
passthrough: true,
enumeration: "ACC_TEST_A,ACC_TEST_B",
},
],
backendParams: [{
type: "REQUEST",
name: "userAge",
location: "PATH",
value: "user_age",
}],
http: {
urlDomain: "opentelekomcloud.my.com",
requestUri: "/getUserAge/{userAge}",
requestMethod: "GET",
requestProtocol: "HTTP",
timeout: 30000,
retryCount: 1,
},
httpPolicies: [{
urlDomain: "opentelekomcloud.my.com",
name: "my_policy1",
requestProtocol: "HTTP",
requestMethod: "GET",
effectiveMode: "ANY",
requestUri: "/getUserAge/{userAge}",
timeout: 30000,
retryCount: 1,
backendParams: [
{
type: "REQUEST",
name: "userAge",
location: "PATH",
value: "user_age",
},
{
type: "SYSTEM",
name: "%[2]s",
location: "HEADER",
value: "serverName",
systemParamType: "internal",
},
],
conditions: [{
origin: "param",
paramName: "user_age",
type: "EXACT",
value: "28",
}],
}],
});
import pulumi
import pulumi_opentelekomcloud as opentelekomcloud
config = pulumi.Config()
vpc_id = config.require_object("vpcId")
subnet_id = config.require_object("subnetId")
secgroup_id = config.require_object("secgroupId")
gateway = opentelekomcloud.ApigwGatewayV2("gateway",
spec_id="BASIC",
vpc_id=vpc_id,
subnet_id=subnet_id,
security_group_id=secgroup_id,
availability_zones=[
"eu-de-01",
"eu-de-02",
],
description="test gateway 2",
ingress_bandwidth_size=5,
ingress_bandwidth_charging_mode="bandwidth",
maintain_begin="02:00:00")
env = opentelekomcloud.ApigwEnvironmentV2("env",
instance_id=gateway.apigw_gateway_v2_id,
description="test description")
group = opentelekomcloud.ApigwGroupV2("group",
instance_id=gateway.apigw_gateway_v2_id,
description="test description",
environments=[{
"variables": [{
"name": "test-name",
"value": "test-value",
}],
"environment_id": env.apigw_environment_v2_id,
}])
api = opentelekomcloud.ApigwApiV2("api",
gateway_id=gateway.apigw_gateway_v2_id,
group_id=group.apigw_group_v2_id,
type="Public",
request_protocol="HTTP",
request_method="GET",
request_uri="/user_info/{user_age}",
security_authentication_type="APP",
match_mode="EXACT",
success_response="Success response",
failure_response="Failed response",
description="Created by script",
request_params=[
{
"name": "user_age",
"type": "NUMBER",
"location": "PATH",
"required": True,
"maximum": 200,
"minimum": 0,
},
{
"name": "X-TEST-ENUM",
"type": "STRING",
"location": "HEADER",
"maximum": 20,
"minimum": 10,
"sample": "ACC_TEST_XXX",
"passthrough": True,
"enumeration": "ACC_TEST_A,ACC_TEST_B",
},
],
backend_params=[{
"type": "REQUEST",
"name": "userAge",
"location": "PATH",
"value": "user_age",
}],
http={
"url_domain": "opentelekomcloud.my.com",
"request_uri": "/getUserAge/{userAge}",
"request_method": "GET",
"request_protocol": "HTTP",
"timeout": 30000,
"retry_count": 1,
},
http_policies=[{
"url_domain": "opentelekomcloud.my.com",
"name": "my_policy1",
"request_protocol": "HTTP",
"request_method": "GET",
"effective_mode": "ANY",
"request_uri": "/getUserAge/{userAge}",
"timeout": 30000,
"retry_count": 1,
"backend_params": [
{
"type": "REQUEST",
"name": "userAge",
"location": "PATH",
"value": "user_age",
},
{
"type": "SYSTEM",
"name": "%[2]s",
"location": "HEADER",
"value": "serverName",
"system_param_type": "internal",
},
],
"conditions": [{
"origin": "param",
"param_name": "user_age",
"type": "EXACT",
"value": "28",
}],
}])
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
"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, "")
vpcId := cfg.RequireObject("vpcId")
subnetId := cfg.RequireObject("subnetId")
secgroupId := cfg.RequireObject("secgroupId")
gateway, err := opentelekomcloud.NewApigwGatewayV2(ctx, "gateway", &opentelekomcloud.ApigwGatewayV2Args{
SpecId: pulumi.String("BASIC"),
VpcId: pulumi.Any(vpcId),
SubnetId: pulumi.Any(subnetId),
SecurityGroupId: pulumi.Any(secgroupId),
AvailabilityZones: pulumi.StringArray{
pulumi.String("eu-de-01"),
pulumi.String("eu-de-02"),
},
Description: pulumi.String("test gateway 2"),
IngressBandwidthSize: pulumi.Float64(5),
IngressBandwidthChargingMode: pulumi.String("bandwidth"),
MaintainBegin: pulumi.String("02:00:00"),
})
if err != nil {
return err
}
env, err := opentelekomcloud.NewApigwEnvironmentV2(ctx, "env", &opentelekomcloud.ApigwEnvironmentV2Args{
InstanceId: gateway.ApigwGatewayV2Id,
Description: pulumi.String("test description"),
})
if err != nil {
return err
}
group, err := opentelekomcloud.NewApigwGroupV2(ctx, "group", &opentelekomcloud.ApigwGroupV2Args{
InstanceId: gateway.ApigwGatewayV2Id,
Description: pulumi.String("test description"),
Environments: opentelekomcloud.ApigwGroupV2EnvironmentArray{
&opentelekomcloud.ApigwGroupV2EnvironmentArgs{
Variables: opentelekomcloud.ApigwGroupV2EnvironmentVariableArray{
&opentelekomcloud.ApigwGroupV2EnvironmentVariableArgs{
Name: pulumi.String("test-name"),
Value: pulumi.String("test-value"),
},
},
EnvironmentId: env.ApigwEnvironmentV2Id,
},
},
})
if err != nil {
return err
}
_, err = opentelekomcloud.NewApigwApiV2(ctx, "api", &opentelekomcloud.ApigwApiV2Args{
GatewayId: gateway.ApigwGatewayV2Id,
GroupId: group.ApigwGroupV2Id,
Type: pulumi.String("Public"),
RequestProtocol: pulumi.String("HTTP"),
RequestMethod: pulumi.String("GET"),
RequestUri: pulumi.String("/user_info/{user_age}"),
SecurityAuthenticationType: pulumi.String("APP"),
MatchMode: pulumi.String("EXACT"),
SuccessResponse: pulumi.String("Success response"),
FailureResponse: pulumi.String("Failed response"),
Description: pulumi.String("Created by script"),
RequestParams: opentelekomcloud.ApigwApiV2RequestParamArray{
&opentelekomcloud.ApigwApiV2RequestParamArgs{
Name: pulumi.String("user_age"),
Type: pulumi.String("NUMBER"),
Location: pulumi.String("PATH"),
Required: pulumi.Bool(true),
Maximum: pulumi.Float64(200),
Minimum: pulumi.Float64(0),
},
&opentelekomcloud.ApigwApiV2RequestParamArgs{
Name: pulumi.String("X-TEST-ENUM"),
Type: pulumi.String("STRING"),
Location: pulumi.String("HEADER"),
Maximum: pulumi.Float64(20),
Minimum: pulumi.Float64(10),
Sample: pulumi.String("ACC_TEST_XXX"),
Passthrough: pulumi.Bool(true),
Enumeration: pulumi.String("ACC_TEST_A,ACC_TEST_B"),
},
},
BackendParams: opentelekomcloud.ApigwApiV2BackendParamArray{
&opentelekomcloud.ApigwApiV2BackendParamArgs{
Type: pulumi.String("REQUEST"),
Name: pulumi.String("userAge"),
Location: pulumi.String("PATH"),
Value: pulumi.String("user_age"),
},
},
Http: &opentelekomcloud.ApigwApiV2HttpArgs{
UrlDomain: pulumi.String("opentelekomcloud.my.com"),
RequestUri: pulumi.String("/getUserAge/{userAge}"),
RequestMethod: pulumi.String("GET"),
RequestProtocol: pulumi.String("HTTP"),
Timeout: pulumi.Float64(30000),
RetryCount: pulumi.Float64(1),
},
HttpPolicies: opentelekomcloud.ApigwApiV2HttpPolicyArray{
&opentelekomcloud.ApigwApiV2HttpPolicyArgs{
UrlDomain: pulumi.String("opentelekomcloud.my.com"),
Name: pulumi.String("my_policy1"),
RequestProtocol: pulumi.String("HTTP"),
RequestMethod: pulumi.String("GET"),
EffectiveMode: pulumi.String("ANY"),
RequestUri: pulumi.String("/getUserAge/{userAge}"),
Timeout: pulumi.Float64(30000),
RetryCount: pulumi.Float64(1),
BackendParams: opentelekomcloud.ApigwApiV2HttpPolicyBackendParamArray{
&opentelekomcloud.ApigwApiV2HttpPolicyBackendParamArgs{
Type: pulumi.String("REQUEST"),
Name: pulumi.String("userAge"),
Location: pulumi.String("PATH"),
Value: pulumi.String("user_age"),
},
&opentelekomcloud.ApigwApiV2HttpPolicyBackendParamArgs{
Type: pulumi.String("SYSTEM"),
Name: pulumi.String("%[2]s"),
Location: pulumi.String("HEADER"),
Value: pulumi.String("serverName"),
SystemParamType: pulumi.String("internal"),
},
},
Conditions: opentelekomcloud.ApigwApiV2HttpPolicyConditionArray{
&opentelekomcloud.ApigwApiV2HttpPolicyConditionArgs{
Origin: pulumi.String("param"),
ParamName: pulumi.String("user_age"),
Type: pulumi.String("EXACT"),
Value: pulumi.String("28"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var vpcId = config.RequireObject<dynamic>("vpcId");
var subnetId = config.RequireObject<dynamic>("subnetId");
var secgroupId = config.RequireObject<dynamic>("secgroupId");
var gateway = new Opentelekomcloud.ApigwGatewayV2("gateway", new()
{
SpecId = "BASIC",
VpcId = vpcId,
SubnetId = subnetId,
SecurityGroupId = secgroupId,
AvailabilityZones = new[]
{
"eu-de-01",
"eu-de-02",
},
Description = "test gateway 2",
IngressBandwidthSize = 5,
IngressBandwidthChargingMode = "bandwidth",
MaintainBegin = "02:00:00",
});
var env = new Opentelekomcloud.ApigwEnvironmentV2("env", new()
{
InstanceId = gateway.ApigwGatewayV2Id,
Description = "test description",
});
var @group = new Opentelekomcloud.ApigwGroupV2("group", new()
{
InstanceId = gateway.ApigwGatewayV2Id,
Description = "test description",
Environments = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentArgs
{
Variables = new[]
{
new Opentelekomcloud.Inputs.ApigwGroupV2EnvironmentVariableArgs
{
Name = "test-name",
Value = "test-value",
},
},
EnvironmentId = env.ApigwEnvironmentV2Id,
},
},
});
var api = new Opentelekomcloud.ApigwApiV2("api", new()
{
GatewayId = gateway.ApigwGatewayV2Id,
GroupId = @group.ApigwGroupV2Id,
Type = "Public",
RequestProtocol = "HTTP",
RequestMethod = "GET",
RequestUri = "/user_info/{user_age}",
SecurityAuthenticationType = "APP",
MatchMode = "EXACT",
SuccessResponse = "Success response",
FailureResponse = "Failed response",
Description = "Created by script",
RequestParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2RequestParamArgs
{
Name = "user_age",
Type = "NUMBER",
Location = "PATH",
Required = true,
Maximum = 200,
Minimum = 0,
},
new Opentelekomcloud.Inputs.ApigwApiV2RequestParamArgs
{
Name = "X-TEST-ENUM",
Type = "STRING",
Location = "HEADER",
Maximum = 20,
Minimum = 10,
Sample = "ACC_TEST_XXX",
Passthrough = true,
Enumeration = "ACC_TEST_A,ACC_TEST_B",
},
},
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2BackendParamArgs
{
Type = "REQUEST",
Name = "userAge",
Location = "PATH",
Value = "user_age",
},
},
Http = new Opentelekomcloud.Inputs.ApigwApiV2HttpArgs
{
UrlDomain = "opentelekomcloud.my.com",
RequestUri = "/getUserAge/{userAge}",
RequestMethod = "GET",
RequestProtocol = "HTTP",
Timeout = 30000,
RetryCount = 1,
},
HttpPolicies = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyArgs
{
UrlDomain = "opentelekomcloud.my.com",
Name = "my_policy1",
RequestProtocol = "HTTP",
RequestMethod = "GET",
EffectiveMode = "ANY",
RequestUri = "/getUserAge/{userAge}",
Timeout = 30000,
RetryCount = 1,
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyBackendParamArgs
{
Type = "REQUEST",
Name = "userAge",
Location = "PATH",
Value = "user_age",
},
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyBackendParamArgs
{
Type = "SYSTEM",
Name = "%[2]s",
Location = "HEADER",
Value = "serverName",
SystemParamType = "internal",
},
},
Conditions = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyConditionArgs
{
Origin = "param",
ParamName = "user_age",
Type = "EXACT",
Value = "28",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwGatewayV2;
import com.pulumi.opentelekomcloud.ApigwGatewayV2Args;
import com.pulumi.opentelekomcloud.ApigwEnvironmentV2;
import com.pulumi.opentelekomcloud.ApigwEnvironmentV2Args;
import com.pulumi.opentelekomcloud.ApigwGroupV2;
import com.pulumi.opentelekomcloud.ApigwGroupV2Args;
import com.pulumi.opentelekomcloud.inputs.ApigwGroupV2EnvironmentArgs;
import com.pulumi.opentelekomcloud.ApigwApiV2;
import com.pulumi.opentelekomcloud.ApigwApiV2Args;
import com.pulumi.opentelekomcloud.inputs.ApigwApiV2RequestParamArgs;
import com.pulumi.opentelekomcloud.inputs.ApigwApiV2BackendParamArgs;
import com.pulumi.opentelekomcloud.inputs.ApigwApiV2HttpArgs;
import com.pulumi.opentelekomcloud.inputs.ApigwApiV2HttpPolicyArgs;
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 vpcId = config.get("vpcId");
final var subnetId = config.get("subnetId");
final var secgroupId = config.get("secgroupId");
var gateway = new ApigwGatewayV2("gateway", ApigwGatewayV2Args.builder()
.specId("BASIC")
.vpcId(vpcId)
.subnetId(subnetId)
.securityGroupId(secgroupId)
.availabilityZones(
"eu-de-01",
"eu-de-02")
.description("test gateway 2")
.ingressBandwidthSize(5)
.ingressBandwidthChargingMode("bandwidth")
.maintainBegin("02:00:00")
.build());
var env = new ApigwEnvironmentV2("env", ApigwEnvironmentV2Args.builder()
.instanceId(gateway.apigwGatewayV2Id())
.description("test description")
.build());
var group = new ApigwGroupV2("group", ApigwGroupV2Args.builder()
.instanceId(gateway.apigwGatewayV2Id())
.description("test description")
.environments(ApigwGroupV2EnvironmentArgs.builder()
.variables(ApigwGroupV2EnvironmentVariableArgs.builder()
.name("test-name")
.value("test-value")
.build())
.environmentId(env.apigwEnvironmentV2Id())
.build())
.build());
var api = new ApigwApiV2("api", ApigwApiV2Args.builder()
.gatewayId(gateway.apigwGatewayV2Id())
.groupId(group.apigwGroupV2Id())
.type("Public")
.requestProtocol("HTTP")
.requestMethod("GET")
.requestUri("/user_info/{user_age}")
.securityAuthenticationType("APP")
.matchMode("EXACT")
.successResponse("Success response")
.failureResponse("Failed response")
.description("Created by script")
.requestParams(
ApigwApiV2RequestParamArgs.builder()
.name("user_age")
.type("NUMBER")
.location("PATH")
.required(true)
.maximum(200)
.minimum(0)
.build(),
ApigwApiV2RequestParamArgs.builder()
.name("X-TEST-ENUM")
.type("STRING")
.location("HEADER")
.maximum(20)
.minimum(10)
.sample("ACC_TEST_XXX")
.passthrough(true)
.enumeration("ACC_TEST_A,ACC_TEST_B")
.build())
.backendParams(ApigwApiV2BackendParamArgs.builder()
.type("REQUEST")
.name("userAge")
.location("PATH")
.value("user_age")
.build())
.http(ApigwApiV2HttpArgs.builder()
.urlDomain("opentelekomcloud.my.com")
.requestUri("/getUserAge/{userAge}")
.requestMethod("GET")
.requestProtocol("HTTP")
.timeout(30000)
.retryCount(1)
.build())
.httpPolicies(ApigwApiV2HttpPolicyArgs.builder()
.urlDomain("opentelekomcloud.my.com")
.name("my_policy1")
.requestProtocol("HTTP")
.requestMethod("GET")
.effectiveMode("ANY")
.requestUri("/getUserAge/{userAge}")
.timeout(30000)
.retryCount(1)
.backendParams(
ApigwApiV2HttpPolicyBackendParamArgs.builder()
.type("REQUEST")
.name("userAge")
.location("PATH")
.value("user_age")
.build(),
ApigwApiV2HttpPolicyBackendParamArgs.builder()
.type("SYSTEM")
.name("%[2]s")
.location("HEADER")
.value("serverName")
.systemParamType("internal")
.build())
.conditions(ApigwApiV2HttpPolicyConditionArgs.builder()
.origin("param")
.paramName("user_age")
.type("EXACT")
.value("28")
.build())
.build())
.build());
}
}
configuration:
vpcId:
type: dynamic
subnetId:
type: dynamic
secgroupId:
type: dynamic
resources:
gateway:
type: opentelekomcloud:ApigwGatewayV2
properties:
specId: BASIC
vpcId: ${vpcId}
subnetId: ${subnetId}
securityGroupId: ${secgroupId}
availabilityZones:
- eu-de-01
- eu-de-02
description: test gateway 2
ingressBandwidthSize: 5
ingressBandwidthChargingMode: bandwidth
maintainBegin: 02:00:00
env:
type: opentelekomcloud:ApigwEnvironmentV2
properties:
instanceId: ${gateway.apigwGatewayV2Id}
description: test description
group:
type: opentelekomcloud:ApigwGroupV2
properties:
instanceId: ${gateway.apigwGatewayV2Id}
description: test description
environments:
- variables:
- name: test-name
value: test-value
environmentId: ${env.apigwEnvironmentV2Id}
api:
type: opentelekomcloud:ApigwApiV2
properties:
gatewayId: ${gateway.apigwGatewayV2Id}
groupId: ${group.apigwGroupV2Id}
type: Public
requestProtocol: HTTP
requestMethod: GET
requestUri: /user_info/{user_age}
securityAuthenticationType: APP
matchMode: EXACT
successResponse: Success response
failureResponse: Failed response
description: Created by script
requestParams:
- name: user_age
type: NUMBER
location: PATH
required: true
maximum: 200
minimum: 0
- name: X-TEST-ENUM
type: STRING
location: HEADER
maximum: 20
minimum: 10
sample: ACC_TEST_XXX
passthrough: true
enumeration: ACC_TEST_A,ACC_TEST_B
backendParams:
- type: REQUEST
name: userAge
location: PATH
value: user_age
http:
urlDomain: opentelekomcloud.my.com
requestUri: /getUserAge/{userAge}
requestMethod: GET
requestProtocol: HTTP
timeout: 30000
retryCount: 1
httpPolicies:
- urlDomain: opentelekomcloud.my.com
name: my_policy1
requestProtocol: HTTP
requestMethod: GET
effectiveMode: ANY
requestUri: /getUserAge/{userAge}
timeout: 30000
retryCount: 1
backendParams:
- type: REQUEST
name: userAge
location: PATH
value: user_age
- type: SYSTEM
name: '%[2]s'
location: HEADER
value: serverName
systemParamType: internal
conditions:
- origin: param
paramName: user_age
type: EXACT
value: '28'
Create ApigwApiV2 Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApigwApiV2(name: string, args: ApigwApiV2Args, opts?: CustomResourceOptions);@overload
def ApigwApiV2(resource_name: str,
args: ApigwApiV2Args,
opts: Optional[ResourceOptions] = None)
@overload
def ApigwApiV2(resource_name: str,
opts: Optional[ResourceOptions] = None,
gateway_id: Optional[str] = None,
type: Optional[str] = None,
request_uri: Optional[str] = None,
request_protocol: Optional[str] = None,
request_method: Optional[str] = None,
group_id: Optional[str] = None,
func_graph: Optional[ApigwApiV2FuncGraphArgs] = None,
region: Optional[str] = None,
func_graph_policies: Optional[Sequence[ApigwApiV2FuncGraphPolicyArgs]] = None,
failure_response: Optional[str] = None,
description: Optional[str] = None,
http: Optional[ApigwApiV2HttpArgs] = None,
http_policies: Optional[Sequence[ApigwApiV2HttpPolicyArgs]] = None,
match_mode: Optional[str] = None,
mock: Optional[ApigwApiV2MockArgs] = None,
mock_policies: Optional[Sequence[ApigwApiV2MockPolicyArgs]] = None,
name: Optional[str] = None,
apigw_api_v2_id: Optional[str] = None,
cors: Optional[bool] = None,
request_params: Optional[Sequence[ApigwApiV2RequestParamArgs]] = None,
body_description: Optional[str] = None,
backend_params: Optional[Sequence[ApigwApiV2BackendParamArgs]] = None,
response_id: Optional[str] = None,
security_authentication_enabled: Optional[bool] = None,
security_authentication_type: Optional[str] = None,
success_response: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
authorizer_id: Optional[str] = None,
version: Optional[str] = None)func NewApigwApiV2(ctx *Context, name string, args ApigwApiV2Args, opts ...ResourceOption) (*ApigwApiV2, error)public ApigwApiV2(string name, ApigwApiV2Args args, CustomResourceOptions? opts = null)
public ApigwApiV2(String name, ApigwApiV2Args args)
public ApigwApiV2(String name, ApigwApiV2Args args, CustomResourceOptions options)
type: opentelekomcloud:ApigwApiV2
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 ApigwApiV2Args
- 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 ApigwApiV2Args
- 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 ApigwApiV2Args
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApigwApiV2Args
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApigwApiV2Args
- 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 apigwApiV2Resource = new Opentelekomcloud.ApigwApiV2("apigwApiV2Resource", new()
{
GatewayId = "string",
Type = "string",
RequestUri = "string",
RequestProtocol = "string",
RequestMethod = "string",
GroupId = "string",
FuncGraph = new Opentelekomcloud.Inputs.ApigwApiV2FuncGraphArgs
{
FunctionUrn = "string",
AuthorizerId = "string",
Description = "string",
InvocationType = "string",
NetworkType = "string",
Timeout = 0,
Version = "string",
},
Region = "string",
FuncGraphPolicies = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2FuncGraphPolicyArgs
{
Conditions = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2FuncGraphPolicyConditionArgs
{
Value = "string",
Origin = "string",
ParamName = "string",
Type = "string",
},
},
FunctionUrn = "string",
Name = "string",
AuthorizerId = "string",
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2FuncGraphPolicyBackendParamArgs
{
Location = "string",
Name = "string",
Type = "string",
Value = "string",
Description = "string",
SystemParamType = "string",
},
},
EffectiveMode = "string",
InvocationType = "string",
NetworkType = "string",
Timeout = 0,
Version = "string",
},
},
FailureResponse = "string",
Description = "string",
Http = new Opentelekomcloud.Inputs.ApigwApiV2HttpArgs
{
RequestMethod = "string",
RequestUri = "string",
AuthorizerId = "string",
Description = "string",
RequestProtocol = "string",
RetryCount = 0,
SslEnable = false,
Timeout = 0,
UrlDomain = "string",
Version = "string",
VpcChannelId = "string",
VpcChannelProxyHost = "string",
},
HttpPolicies = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyArgs
{
Name = "string",
RequestUri = "string",
Conditions = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyConditionArgs
{
Value = "string",
Origin = "string",
ParamName = "string",
Type = "string",
},
},
RequestMethod = "string",
RequestProtocol = "string",
EffectiveMode = "string",
AuthorizerId = "string",
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2HttpPolicyBackendParamArgs
{
Location = "string",
Name = "string",
Type = "string",
Value = "string",
Description = "string",
SystemParamType = "string",
},
},
RetryCount = 0,
Timeout = 0,
UrlDomain = "string",
VpcChannelId = "string",
VpcChannelProxyHost = "string",
},
},
MatchMode = "string",
Mock = new Opentelekomcloud.Inputs.ApigwApiV2MockArgs
{
AuthorizerId = "string",
Description = "string",
Response = "string",
Version = "string",
},
MockPolicies = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2MockPolicyArgs
{
Conditions = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2MockPolicyConditionArgs
{
Value = "string",
Origin = "string",
ParamName = "string",
Type = "string",
},
},
Name = "string",
AuthorizerId = "string",
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2MockPolicyBackendParamArgs
{
Location = "string",
Name = "string",
Type = "string",
Value = "string",
Description = "string",
SystemParamType = "string",
},
},
EffectiveMode = "string",
Response = "string",
},
},
Name = "string",
ApigwApiV2Id = "string",
Cors = false,
RequestParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2RequestParamArgs
{
Name = "string",
Default = "string",
Description = "string",
Enumeration = "string",
Location = "string",
Maximum = 0,
Minimum = 0,
Passthrough = false,
Required = false,
Sample = "string",
Type = "string",
ValidityCheck = false,
},
},
BodyDescription = "string",
BackendParams = new[]
{
new Opentelekomcloud.Inputs.ApigwApiV2BackendParamArgs
{
Location = "string",
Name = "string",
Type = "string",
Value = "string",
Description = "string",
SystemParamType = "string",
},
},
ResponseId = "string",
SecurityAuthenticationEnabled = false,
SecurityAuthenticationType = "string",
SuccessResponse = "string",
Tags = new[]
{
"string",
},
AuthorizerId = "string",
Version = "string",
});
example, err := opentelekomcloud.NewApigwApiV2(ctx, "apigwApiV2Resource", &opentelekomcloud.ApigwApiV2Args{
GatewayId: pulumi.String("string"),
Type: pulumi.String("string"),
RequestUri: pulumi.String("string"),
RequestProtocol: pulumi.String("string"),
RequestMethod: pulumi.String("string"),
GroupId: pulumi.String("string"),
FuncGraph: &opentelekomcloud.ApigwApiV2FuncGraphArgs{
FunctionUrn: pulumi.String("string"),
AuthorizerId: pulumi.String("string"),
Description: pulumi.String("string"),
InvocationType: pulumi.String("string"),
NetworkType: pulumi.String("string"),
Timeout: pulumi.Float64(0),
Version: pulumi.String("string"),
},
Region: pulumi.String("string"),
FuncGraphPolicies: opentelekomcloud.ApigwApiV2FuncGraphPolicyArray{
&opentelekomcloud.ApigwApiV2FuncGraphPolicyArgs{
Conditions: opentelekomcloud.ApigwApiV2FuncGraphPolicyConditionArray{
&opentelekomcloud.ApigwApiV2FuncGraphPolicyConditionArgs{
Value: pulumi.String("string"),
Origin: pulumi.String("string"),
ParamName: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
FunctionUrn: pulumi.String("string"),
Name: pulumi.String("string"),
AuthorizerId: pulumi.String("string"),
BackendParams: opentelekomcloud.ApigwApiV2FuncGraphPolicyBackendParamArray{
&opentelekomcloud.ApigwApiV2FuncGraphPolicyBackendParamArgs{
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"),
InvocationType: pulumi.String("string"),
NetworkType: pulumi.String("string"),
Timeout: pulumi.Float64(0),
Version: pulumi.String("string"),
},
},
FailureResponse: pulumi.String("string"),
Description: pulumi.String("string"),
Http: &opentelekomcloud.ApigwApiV2HttpArgs{
RequestMethod: pulumi.String("string"),
RequestUri: pulumi.String("string"),
AuthorizerId: pulumi.String("string"),
Description: pulumi.String("string"),
RequestProtocol: pulumi.String("string"),
RetryCount: pulumi.Float64(0),
SslEnable: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
UrlDomain: pulumi.String("string"),
Version: pulumi.String("string"),
VpcChannelId: pulumi.String("string"),
VpcChannelProxyHost: pulumi.String("string"),
},
HttpPolicies: opentelekomcloud.ApigwApiV2HttpPolicyArray{
&opentelekomcloud.ApigwApiV2HttpPolicyArgs{
Name: pulumi.String("string"),
RequestUri: pulumi.String("string"),
Conditions: opentelekomcloud.ApigwApiV2HttpPolicyConditionArray{
&opentelekomcloud.ApigwApiV2HttpPolicyConditionArgs{
Value: pulumi.String("string"),
Origin: pulumi.String("string"),
ParamName: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
RequestMethod: pulumi.String("string"),
RequestProtocol: pulumi.String("string"),
EffectiveMode: pulumi.String("string"),
AuthorizerId: pulumi.String("string"),
BackendParams: opentelekomcloud.ApigwApiV2HttpPolicyBackendParamArray{
&opentelekomcloud.ApigwApiV2HttpPolicyBackendParamArgs{
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.String("string"),
Value: pulumi.String("string"),
Description: pulumi.String("string"),
SystemParamType: pulumi.String("string"),
},
},
RetryCount: pulumi.Float64(0),
Timeout: pulumi.Float64(0),
UrlDomain: pulumi.String("string"),
VpcChannelId: pulumi.String("string"),
VpcChannelProxyHost: pulumi.String("string"),
},
},
MatchMode: pulumi.String("string"),
Mock: &opentelekomcloud.ApigwApiV2MockArgs{
AuthorizerId: pulumi.String("string"),
Description: pulumi.String("string"),
Response: pulumi.String("string"),
Version: pulumi.String("string"),
},
MockPolicies: opentelekomcloud.ApigwApiV2MockPolicyArray{
&opentelekomcloud.ApigwApiV2MockPolicyArgs{
Conditions: opentelekomcloud.ApigwApiV2MockPolicyConditionArray{
&opentelekomcloud.ApigwApiV2MockPolicyConditionArgs{
Value: pulumi.String("string"),
Origin: pulumi.String("string"),
ParamName: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Name: pulumi.String("string"),
AuthorizerId: pulumi.String("string"),
BackendParams: opentelekomcloud.ApigwApiV2MockPolicyBackendParamArray{
&opentelekomcloud.ApigwApiV2MockPolicyBackendParamArgs{
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"),
ApigwApiV2Id: pulumi.String("string"),
Cors: pulumi.Bool(false),
RequestParams: opentelekomcloud.ApigwApiV2RequestParamArray{
&opentelekomcloud.ApigwApiV2RequestParamArgs{
Name: pulumi.String("string"),
Default: pulumi.String("string"),
Description: pulumi.String("string"),
Enumeration: pulumi.String("string"),
Location: pulumi.String("string"),
Maximum: pulumi.Float64(0),
Minimum: pulumi.Float64(0),
Passthrough: pulumi.Bool(false),
Required: pulumi.Bool(false),
Sample: pulumi.String("string"),
Type: pulumi.String("string"),
ValidityCheck: pulumi.Bool(false),
},
},
BodyDescription: pulumi.String("string"),
BackendParams: opentelekomcloud.ApigwApiV2BackendParamArray{
&opentelekomcloud.ApigwApiV2BackendParamArgs{
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"),
SecurityAuthenticationEnabled: pulumi.Bool(false),
SecurityAuthenticationType: pulumi.String("string"),
SuccessResponse: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
AuthorizerId: pulumi.String("string"),
Version: pulumi.String("string"),
})
var apigwApiV2Resource = new ApigwApiV2("apigwApiV2Resource", ApigwApiV2Args.builder()
.gatewayId("string")
.type("string")
.requestUri("string")
.requestProtocol("string")
.requestMethod("string")
.groupId("string")
.funcGraph(ApigwApiV2FuncGraphArgs.builder()
.functionUrn("string")
.authorizerId("string")
.description("string")
.invocationType("string")
.networkType("string")
.timeout(0)
.version("string")
.build())
.region("string")
.funcGraphPolicies(ApigwApiV2FuncGraphPolicyArgs.builder()
.conditions(ApigwApiV2FuncGraphPolicyConditionArgs.builder()
.value("string")
.origin("string")
.paramName("string")
.type("string")
.build())
.functionUrn("string")
.name("string")
.authorizerId("string")
.backendParams(ApigwApiV2FuncGraphPolicyBackendParamArgs.builder()
.location("string")
.name("string")
.type("string")
.value("string")
.description("string")
.systemParamType("string")
.build())
.effectiveMode("string")
.invocationType("string")
.networkType("string")
.timeout(0)
.version("string")
.build())
.failureResponse("string")
.description("string")
.http(ApigwApiV2HttpArgs.builder()
.requestMethod("string")
.requestUri("string")
.authorizerId("string")
.description("string")
.requestProtocol("string")
.retryCount(0)
.sslEnable(false)
.timeout(0)
.urlDomain("string")
.version("string")
.vpcChannelId("string")
.vpcChannelProxyHost("string")
.build())
.httpPolicies(ApigwApiV2HttpPolicyArgs.builder()
.name("string")
.requestUri("string")
.conditions(ApigwApiV2HttpPolicyConditionArgs.builder()
.value("string")
.origin("string")
.paramName("string")
.type("string")
.build())
.requestMethod("string")
.requestProtocol("string")
.effectiveMode("string")
.authorizerId("string")
.backendParams(ApigwApiV2HttpPolicyBackendParamArgs.builder()
.location("string")
.name("string")
.type("string")
.value("string")
.description("string")
.systemParamType("string")
.build())
.retryCount(0)
.timeout(0)
.urlDomain("string")
.vpcChannelId("string")
.vpcChannelProxyHost("string")
.build())
.matchMode("string")
.mock(ApigwApiV2MockArgs.builder()
.authorizerId("string")
.description("string")
.response("string")
.version("string")
.build())
.mockPolicies(ApigwApiV2MockPolicyArgs.builder()
.conditions(ApigwApiV2MockPolicyConditionArgs.builder()
.value("string")
.origin("string")
.paramName("string")
.type("string")
.build())
.name("string")
.authorizerId("string")
.backendParams(ApigwApiV2MockPolicyBackendParamArgs.builder()
.location("string")
.name("string")
.type("string")
.value("string")
.description("string")
.systemParamType("string")
.build())
.effectiveMode("string")
.response("string")
.build())
.name("string")
.apigwApiV2Id("string")
.cors(false)
.requestParams(ApigwApiV2RequestParamArgs.builder()
.name("string")
.default_("string")
.description("string")
.enumeration("string")
.location("string")
.maximum(0)
.minimum(0)
.passthrough(false)
.required(false)
.sample("string")
.type("string")
.validityCheck(false)
.build())
.bodyDescription("string")
.backendParams(ApigwApiV2BackendParamArgs.builder()
.location("string")
.name("string")
.type("string")
.value("string")
.description("string")
.systemParamType("string")
.build())
.responseId("string")
.securityAuthenticationEnabled(false)
.securityAuthenticationType("string")
.successResponse("string")
.tags("string")
.authorizerId("string")
.version("string")
.build());
apigw_api_v2_resource = opentelekomcloud.ApigwApiV2("apigwApiV2Resource",
gateway_id="string",
type="string",
request_uri="string",
request_protocol="string",
request_method="string",
group_id="string",
func_graph={
"function_urn": "string",
"authorizer_id": "string",
"description": "string",
"invocation_type": "string",
"network_type": "string",
"timeout": 0,
"version": "string",
},
region="string",
func_graph_policies=[{
"conditions": [{
"value": "string",
"origin": "string",
"param_name": "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_type": "string",
"network_type": "string",
"timeout": 0,
"version": "string",
}],
failure_response="string",
description="string",
http={
"request_method": "string",
"request_uri": "string",
"authorizer_id": "string",
"description": "string",
"request_protocol": "string",
"retry_count": 0,
"ssl_enable": False,
"timeout": 0,
"url_domain": "string",
"version": "string",
"vpc_channel_id": "string",
"vpc_channel_proxy_host": "string",
},
http_policies=[{
"name": "string",
"request_uri": "string",
"conditions": [{
"value": "string",
"origin": "string",
"param_name": "string",
"type": "string",
}],
"request_method": "string",
"request_protocol": "string",
"effective_mode": "string",
"authorizer_id": "string",
"backend_params": [{
"location": "string",
"name": "string",
"type": "string",
"value": "string",
"description": "string",
"system_param_type": "string",
}],
"retry_count": 0,
"timeout": 0,
"url_domain": "string",
"vpc_channel_id": "string",
"vpc_channel_proxy_host": "string",
}],
match_mode="string",
mock={
"authorizer_id": "string",
"description": "string",
"response": "string",
"version": "string",
},
mock_policies=[{
"conditions": [{
"value": "string",
"origin": "string",
"param_name": "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",
apigw_api_v2_id="string",
cors=False,
request_params=[{
"name": "string",
"default": "string",
"description": "string",
"enumeration": "string",
"location": "string",
"maximum": 0,
"minimum": 0,
"passthrough": False,
"required": False,
"sample": "string",
"type": "string",
"validity_check": False,
}],
body_description="string",
backend_params=[{
"location": "string",
"name": "string",
"type": "string",
"value": "string",
"description": "string",
"system_param_type": "string",
}],
response_id="string",
security_authentication_enabled=False,
security_authentication_type="string",
success_response="string",
tags=["string"],
authorizer_id="string",
version="string")
const apigwApiV2Resource = new opentelekomcloud.ApigwApiV2("apigwApiV2Resource", {
gatewayId: "string",
type: "string",
requestUri: "string",
requestProtocol: "string",
requestMethod: "string",
groupId: "string",
funcGraph: {
functionUrn: "string",
authorizerId: "string",
description: "string",
invocationType: "string",
networkType: "string",
timeout: 0,
version: "string",
},
region: "string",
funcGraphPolicies: [{
conditions: [{
value: "string",
origin: "string",
paramName: "string",
type: "string",
}],
functionUrn: "string",
name: "string",
authorizerId: "string",
backendParams: [{
location: "string",
name: "string",
type: "string",
value: "string",
description: "string",
systemParamType: "string",
}],
effectiveMode: "string",
invocationType: "string",
networkType: "string",
timeout: 0,
version: "string",
}],
failureResponse: "string",
description: "string",
http: {
requestMethod: "string",
requestUri: "string",
authorizerId: "string",
description: "string",
requestProtocol: "string",
retryCount: 0,
sslEnable: false,
timeout: 0,
urlDomain: "string",
version: "string",
vpcChannelId: "string",
vpcChannelProxyHost: "string",
},
httpPolicies: [{
name: "string",
requestUri: "string",
conditions: [{
value: "string",
origin: "string",
paramName: "string",
type: "string",
}],
requestMethod: "string",
requestProtocol: "string",
effectiveMode: "string",
authorizerId: "string",
backendParams: [{
location: "string",
name: "string",
type: "string",
value: "string",
description: "string",
systemParamType: "string",
}],
retryCount: 0,
timeout: 0,
urlDomain: "string",
vpcChannelId: "string",
vpcChannelProxyHost: "string",
}],
matchMode: "string",
mock: {
authorizerId: "string",
description: "string",
response: "string",
version: "string",
},
mockPolicies: [{
conditions: [{
value: "string",
origin: "string",
paramName: "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",
apigwApiV2Id: "string",
cors: false,
requestParams: [{
name: "string",
"default": "string",
description: "string",
enumeration: "string",
location: "string",
maximum: 0,
minimum: 0,
passthrough: false,
required: false,
sample: "string",
type: "string",
validityCheck: false,
}],
bodyDescription: "string",
backendParams: [{
location: "string",
name: "string",
type: "string",
value: "string",
description: "string",
systemParamType: "string",
}],
responseId: "string",
securityAuthenticationEnabled: false,
securityAuthenticationType: "string",
successResponse: "string",
tags: ["string"],
authorizerId: "string",
version: "string",
});
type: opentelekomcloud:ApigwApiV2
properties:
apigwApiV2Id: 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
description: string
functionUrn: string
invocationType: string
networkType: string
timeout: 0
version: string
funcGraphPolicies:
- authorizerId: string
backendParams:
- description: string
location: string
name: string
systemParamType: string
type: string
value: string
conditions:
- origin: string
paramName: string
type: string
value: string
effectiveMode: string
functionUrn: string
invocationType: string
name: string
networkType: string
timeout: 0
version: string
gatewayId: string
groupId: string
http:
authorizerId: string
description: string
requestMethod: string
requestProtocol: string
requestUri: string
retryCount: 0
sslEnable: false
timeout: 0
urlDomain: string
version: string
vpcChannelId: string
vpcChannelProxyHost: string
httpPolicies:
- authorizerId: string
backendParams:
- description: string
location: string
name: string
systemParamType: string
type: string
value: string
conditions:
- origin: string
paramName: string
type: string
value: string
effectiveMode: string
name: string
requestMethod: string
requestProtocol: string
requestUri: string
retryCount: 0
timeout: 0
urlDomain: string
vpcChannelId: string
vpcChannelProxyHost: string
matchMode: string
mock:
authorizerId: string
description: string
response: string
version: string
mockPolicies:
- authorizerId: string
backendParams:
- description: string
location: string
name: string
systemParamType: string
type: string
value: string
conditions:
- origin: string
paramName: string
type: string
value: string
effectiveMode: string
name: string
response: string
name: string
region: string
requestMethod: string
requestParams:
- default: string
description: string
enumeration: string
location: string
maximum: 0
minimum: 0
name: string
passthrough: false
required: false
sample: string
type: string
validityCheck: false
requestProtocol: string
requestUri: string
responseId: string
securityAuthenticationEnabled: false
securityAuthenticationType: string
successResponse: string
tags:
- string
type: string
version: string
ApigwApiV2 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 ApigwApiV2 resource accepts the following input properties:
- Gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- Group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params List<ApigwApi V2Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Body
Description 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,480characters. - Cors bool
- Specifies whether CORS is supported, defaults to
false. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - Func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- Func
Graph List<ApigwPolicies Api V2Func Graph Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- Http
Policies List<ApigwApi V2Http Policy> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- Match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - Mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- Mock
Policies List<ApigwApi V2Mock Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- Request
Params List<ApigwApi V2Request Param> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- Response
Id string - Specifies the APIG group response ID.
- Security
Authentication boolEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - Security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - Success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<string>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - Version string
- Specifies the version of the FunctionGraph function.
- Gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- Group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params []ApigwApi V2Backend Param Args - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Body
Description 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,480characters. - Cors bool
- Specifies whether CORS is supported, defaults to
false. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - Func
Graph ApigwApi V2Func Graph Args - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- Func
Graph []ApigwPolicies Api V2Func Graph Policy Args - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Http
Apigw
Api V2Http Args - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- Http
Policies []ApigwApi V2Http Policy Args Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- Match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - Mock
Apigw
Api V2Mock Args - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- Mock
Policies []ApigwApi V2Mock Policy Args - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- Request
Params []ApigwApi V2Request Param Args - Specifies the configurations of the front-end parameters. The object structure is documented below.
- Response
Id string - Specifies the APIG group response ID.
- Security
Authentication boolEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - Security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - Success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - []string
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - Version string
- Specifies the version of the FunctionGraph function.
- gateway
Id String - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id String - Specifies an ID of the APIG group to which the API belongs to.
- request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - apigw
Api StringV2Id - The ID of the API.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params List<ApigwApi V2Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- body
Description 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,480characters. - cors Boolean
- Specifies whether CORS is supported, defaults to
false. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response String - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph List<ApigwPolicies Api V2Func Graph Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies List<ApigwApi V2Http Policy> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode String - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies List<ApigwApi V2Mock Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region String
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- request
Params List<ApigwApi V2Request Param> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- response
Id String - Specifies the APIG group response ID.
- security
Authentication BooleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication StringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response String - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<String>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - version String
- Specifies the version of the FunctionGraph function.
- gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params ApigwApi V2Backend Param[] - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- body
Description 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,480characters. - cors boolean
- Specifies whether CORS is supported, defaults to
false. - description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph ApigwPolicies Api V2Func Graph Policy[] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies ApigwApi V2Http Policy[] Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies ApigwApi V2Mock Policy[] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- request
Params ApigwApi V2Request Param[] - Specifies the configurations of the front-end parameters. The object structure is documented below.
- response
Id string - Specifies the APIG group response ID.
- security
Authentication booleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - string[]
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - version string
- Specifies the version of the FunctionGraph function.
- gateway_
id str - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group_
id str - Specifies an ID of the APIG group to which the API belongs to.
- request_
method str - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request_
protocol str - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request_
uri str - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - apigw_
api_ strv2_ id - The ID of the API.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend_
params Sequence[ApigwApi V2Backend Param Args] - 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,480characters. - cors bool
- Specifies whether CORS is supported, defaults to
false. - description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure_
response str - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func_
graph ApigwApi V2Func Graph Args - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func_
graph_ Sequence[Apigwpolicies Api V2Func Graph Policy Args] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- http
Apigw
Api V2Http Args - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http_
policies Sequence[ApigwApi V2Http Policy Args] Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match_
mode str - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock Args - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock_
policies Sequence[ApigwApi V2Mock Policy Args] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region str
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- request_
params Sequence[ApigwApi V2Request Param Args] - Specifies the configurations of the front-end parameters. The object structure is documented below.
- response_
id str - Specifies the APIG group response ID.
- security_
authentication_ boolenabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security_
authentication_ strtype - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success_
response str - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - Sequence[str]
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - version str
- Specifies the version of the FunctionGraph function.
- gateway
Id String - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id String - Specifies an ID of the APIG group to which the API belongs to.
- request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - apigw
Api StringV2Id - The ID of the API.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params 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.
- body
Description 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,480characters. - cors Boolean
- Specifies whether CORS is supported, defaults to
false. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response String - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph Property Map - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph List<Property Map>Policies - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- http Property Map
- Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies List<Property Map> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode String - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock Property Map
- Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies List<Property Map> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region String
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- request
Params List<Property Map> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- response
Id String - Specifies the APIG group response ID.
- security
Authentication BooleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication StringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response String - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<String>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - version String
- Specifies the version of the FunctionGraph function.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApigwApiV2 resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Registered
At string - Time when the API is registered.
- Updated
At string - Time when the API was last modified.
- Id string
- The provider-assigned unique ID for this managed resource.
- Registered
At string - Time when the API is registered.
- Updated
At string - Time when the API was last modified.
- id String
- The provider-assigned unique ID for this managed resource.
- registered
At String - Time when the API is registered.
- updated
At String - Time when the API was last modified.
- id string
- The provider-assigned unique ID for this managed resource.
- registered
At string - Time when the API is registered.
- updated
At string - Time when the API was last modified.
- id str
- The provider-assigned unique ID for this managed resource.
- registered_
at str - Time when the API is registered.
- updated_
at str - Time when the API was last modified.
- id String
- The provider-assigned unique ID for this managed resource.
- registered
At String - Time when the API is registered.
- updated
At String - Time when the API was last modified.
Look up Existing ApigwApiV2 Resource
Get an existing ApigwApiV2 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?: ApigwApiV2State, opts?: CustomResourceOptions): ApigwApiV2@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
apigw_api_v2_id: Optional[str] = None,
authorizer_id: Optional[str] = None,
backend_params: Optional[Sequence[ApigwApiV2BackendParamArgs]] = None,
body_description: Optional[str] = None,
cors: Optional[bool] = None,
description: Optional[str] = None,
failure_response: Optional[str] = None,
func_graph: Optional[ApigwApiV2FuncGraphArgs] = None,
func_graph_policies: Optional[Sequence[ApigwApiV2FuncGraphPolicyArgs]] = None,
gateway_id: Optional[str] = None,
group_id: Optional[str] = None,
http: Optional[ApigwApiV2HttpArgs] = None,
http_policies: Optional[Sequence[ApigwApiV2HttpPolicyArgs]] = None,
match_mode: Optional[str] = None,
mock: Optional[ApigwApiV2MockArgs] = None,
mock_policies: Optional[Sequence[ApigwApiV2MockPolicyArgs]] = None,
name: Optional[str] = None,
region: Optional[str] = None,
registered_at: Optional[str] = None,
request_method: Optional[str] = None,
request_params: Optional[Sequence[ApigwApiV2RequestParamArgs]] = None,
request_protocol: Optional[str] = None,
request_uri: Optional[str] = None,
response_id: Optional[str] = None,
security_authentication_enabled: Optional[bool] = None,
security_authentication_type: Optional[str] = None,
success_response: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
type: Optional[str] = None,
updated_at: Optional[str] = None,
version: Optional[str] = None) -> ApigwApiV2func GetApigwApiV2(ctx *Context, name string, id IDInput, state *ApigwApiV2State, opts ...ResourceOption) (*ApigwApiV2, error)public static ApigwApiV2 Get(string name, Input<string> id, ApigwApiV2State? state, CustomResourceOptions? opts = null)public static ApigwApiV2 get(String name, Output<String> id, ApigwApiV2State state, CustomResourceOptions options)resources: _: type: opentelekomcloud:ApigwApiV2 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.
- Apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params List<ApigwApi V2Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Body
Description 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,480characters. - Cors bool
- Specifies whether CORS is supported, defaults to
false. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - Func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- Func
Graph List<ApigwPolicies Api V2Func Graph Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- Group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- Http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- Http
Policies List<ApigwApi V2Http Policy> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- Match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - Mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- Mock
Policies List<ApigwApi V2Mock Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- Registered
At string - Time when the API is registered.
- Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Params List<ApigwApi V2Request Param> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- Response
Id string - Specifies the APIG group response ID.
- Security
Authentication boolEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - Security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - Success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<string>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Updated
At string - Time when the API was last modified.
- Version string
- Specifies the version of the FunctionGraph function.
- Apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params []ApigwApi V2Backend Param Args - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Body
Description 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,480characters. - Cors bool
- Specifies whether CORS is supported, defaults to
false. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - Func
Graph ApigwApi V2Func Graph Args - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- Func
Graph []ApigwPolicies Api V2Func Graph Policy Args - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- Group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- Http
Apigw
Api V2Http Args - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- Http
Policies []ApigwApi V2Http Policy Args Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- Match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - Mock
Apigw
Api V2Mock Args - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- Mock
Policies []ApigwApi V2Mock Policy Args - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- Registered
At string - Time when the API is registered.
- Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Params []ApigwApi V2Request Param Args - Specifies the configurations of the front-end parameters. The object structure is documented below.
- Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- Response
Id string - Specifies the APIG group response ID.
- Security
Authentication boolEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - Security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - Success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - []string
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Updated
At string - Time when the API was last modified.
- Version string
- Specifies the version of the FunctionGraph function.
- apigw
Api StringV2Id - The ID of the API.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params List<ApigwApi V2Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- body
Description 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,480characters. - cors Boolean
- Specifies whether CORS is supported, defaults to
false. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response String - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph List<ApigwPolicies Api V2Func Graph Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- gateway
Id String - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id String - Specifies an ID of the APIG group to which the API belongs to.
- http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies List<ApigwApi V2Http Policy> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode String - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies List<ApigwApi V2Mock Policy> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region String
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- registered
At String - Time when the API is registered.
- request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Params List<ApigwApi V2Request Param> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- response
Id String - Specifies the APIG group response ID.
- security
Authentication BooleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication StringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response String - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<String>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - updated
At String - Time when the API was last modified.
- version String
- Specifies the version of the FunctionGraph function.
- apigw
Api stringV2Id - The ID of the API.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params ApigwApi V2Backend Param[] - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- body
Description 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,480characters. - cors boolean
- Specifies whether CORS is supported, defaults to
false. - description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response string - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph ApigwApi V2Func Graph - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph ApigwPolicies Api V2Func Graph Policy[] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- gateway
Id string - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id string - Specifies an ID of the APIG group to which the API belongs to.
- http
Apigw
Api V2Http - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies ApigwApi V2Http Policy[] Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode string - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies ApigwApi V2Mock Policy[] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region string
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- registered
At string - Time when the API is registered.
- request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Params ApigwApi V2Request Param[] - Specifies the configurations of the front-end parameters. The object structure is documented below.
- request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- response
Id string - Specifies the APIG group response ID.
- security
Authentication booleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication stringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response string - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - string[]
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - updated
At string - Time when the API was last modified.
- version string
- Specifies the version of the FunctionGraph function.
- apigw_
api_ strv2_ id - The ID of the API.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend_
params Sequence[ApigwApi V2Backend Param Args] - 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,480characters. - cors bool
- Specifies whether CORS is supported, defaults to
false. - description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure_
response str - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func_
graph ApigwApi V2Func Graph Args - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func_
graph_ Sequence[Apigwpolicies Api V2Func Graph Policy Args] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- gateway_
id str - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group_
id str - Specifies an ID of the APIG group to which the API belongs to.
- http
Apigw
Api V2Http Args - Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http_
policies Sequence[ApigwApi V2Http Policy Args] Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match_
mode str - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock
Apigw
Api V2Mock Args - Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock_
policies Sequence[ApigwApi V2Mock Policy Args] - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region str
- Specifies the region where the API is located. 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.
- request_
method str - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request_
params Sequence[ApigwApi V2Request Param Args] - Specifies the configurations of the front-end parameters. The object structure is documented below.
- request_
protocol str - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request_
uri str - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- response_
id str - Specifies the APIG group response ID.
- security_
authentication_ boolenabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security_
authentication_ strtype - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success_
response str - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - Sequence[str]
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - updated_
at str - Time when the API was last modified.
- version str
- Specifies the version of the FunctionGraph function.
- apigw
Api StringV2Id - The ID of the API.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params 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.
- body
Description 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,480characters. - cors Boolean
- Specifies whether CORS is supported, defaults to
false. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - failure
Response String - Specifies the example response for a failure request.
The response contains a maximum of
20,480characters. - func
Graph Property Map - Specifies the function graph backend details. The object structure is documented below. Changing this will create a new API resource.
- func
Graph List<Property Map>Policies - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- gateway
Id String - Specifies an ID of the APIG dedicated instance to which the API belongs to. Changing this will create a new API resource.
- group
Id String - Specifies an ID of the APIG group to which the API belongs to.
- http Property Map
- Specifies the web backend details. The object structure is documented below. Changing this will create a new API resource.
- http
Policies List<Property Map> Specifies the example response for a failed request. The maximum blocks of the policy is 5. The object structure is documented below.
The
request_paramsblock supports:- match
Mode String - Specifies the route matching mode.
The valid values are
EXACTandPREFIX, defaults toEXACT. - mock Property Map
- Specifies the mock backend details. The object structure is documented below. Changing this will create a new API resource.
- mock
Policies List<Property Map> - Specifies the Mock policy backends. The maximum blocks of the policy is 5. The object structure is documented below.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - region String
- Specifies the region where the API is located. If omitted, the provider-level region will be used. Changing this will create a new API resource.
- registered
At String - Time when the API is registered.
- request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Params List<Property Map> - Specifies the configurations of the front-end parameters. The object structure is documented below.
- request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- response
Id String - Specifies the APIG group response ID.
- security
Authentication BooleanEnabled - Specifies whether the authentication of the application code is enabled.
The application code must located in the header when
security_authentication_enabledistrue. - security
Authentication StringType - Specifies the security authentication mode of the API request.
The valid values are
NONE,APP,IAMandAUTHORIZER, defaults toNONE. - success
Response String - Specifies the example response for a successful request.
The response contains a maximum of
20,480characters. - List<String>
- Tags. Use letters, digits, and special characters
(-*#%.:_)and start with a letter. By default,10tags are supported. To increase the quota, contact technical support to modify theAPI_TAG_NUM_LIMITconfiguration. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - updated
At String - Time when the API was last modified.
- version String
- Specifies the version of the FunctionGraph function.
Supporting Types
ApigwApiV2BackendParam, ApigwApiV2BackendParamArgs
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location str
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system_
param_ strtype Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
ApigwApiV2FuncGraph, ApigwApiV2FuncGraphArgs
- Function
Urn string - Specifies the URN of the FunctionGraph function.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - Network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - Timeout double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Version string
- Specifies the version of the FunctionGraph function.
- Function
Urn string - Specifies the URN of the FunctionGraph function.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - Network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - Timeout float64
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Version string
- Specifies the version of the FunctionGraph function.
- function
Urn String - Specifies the URN of the FunctionGraph function.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - invocation
Type String - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type String - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout Double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version String
- Specifies the version of the FunctionGraph function.
- function
Urn string - Specifies the URN of the FunctionGraph function.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version string
- Specifies the version of the FunctionGraph function.
- function_
urn str - Specifies the URN of the FunctionGraph function.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - invocation_
type str - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network_
type str - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout float
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version str
- Specifies the version of the FunctionGraph function.
- function
Urn String - Specifies the URN of the FunctionGraph function.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - invocation
Type String - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type String - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout Number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version String
- Specifies the version of the FunctionGraph function.
ApigwApiV2FuncGraphPolicy, ApigwApiV2FuncGraphPolicyArgs
- Conditions
List<Apigw
Api V2Func Graph Policy Condition> - Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
- Function
Urn string - Specifies the URN of the FunctionGraph function.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params List<ApigwApi V2Func Graph Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - Network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - Timeout double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Version string
- Specifies the version of the FunctionGraph function.
- Conditions
[]Apigw
Api V2Func Graph Policy Condition - Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
- Function
Urn string - Specifies the URN of the FunctionGraph function.
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params []ApigwApi V2Func Graph Policy Backend Param - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - Network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - Timeout float64
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Version string
- Specifies the version of the FunctionGraph function.
- conditions
List<Apigw
Api V2Func Graph Policy Condition> - Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
- function
Urn String - Specifies the URN of the FunctionGraph function.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params List<ApigwApi V2Func Graph Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - invocation
Type String - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type String - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout Double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version String
- Specifies the version of the FunctionGraph function.
- conditions
Apigw
Api V2Func Graph Policy Condition[] - Specifies an array of one or more policy conditions. Up to five conditions can be set. The object structure is documented below.
- function
Urn string - Specifies the URN of the FunctionGraph function.
- name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params ApigwApi V2Func Graph Policy Backend Param[] - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - invocation
Type string - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type string - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version string
- Specifies the version of the FunctionGraph function.
- conditions
Sequence[Apigw
Api V2Func Graph Policy Condition] - 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 FunctionGraph function.
- name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend_
params Sequence[ApigwApi V2Func Graph Policy Backend Param] - 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
ALLandANY, defaults toANY. - invocation_
type str - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network_
type str - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout float
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version str
- Specifies the version of the FunctionGraph function.
- 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.
- function
Urn String - Specifies the URN of the FunctionGraph function.
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params 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.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - invocation
Type String - Specifies the invocation type.
The valid values are
asyncandsync, defaults tosync. - network
Type String - Function network architecture.
The valid values are
VPCandNON-VPC, defaults toNON-VPC. - timeout Number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - version String
- Specifies the version of the FunctionGraph function.
ApigwApiV2FuncGraphPolicyBackendParam, ApigwApiV2FuncGraphPolicyBackendParamArgs
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location str
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system_
param_ strtype Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
ApigwApiV2FuncGraphPolicyCondition, ApigwApiV2FuncGraphPolicyConditionArgs
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin str
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param_
name str - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
ApigwApiV2Http, ApigwApiV2HttpArgs
- Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Retry
Count double Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- Ssl
Enable bool - Specifies whether to enable two-way authentication, defaults to false.
- Timeout double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - Version string
- Specifies the version of the FunctionGraph function.
- Vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - Vpc
Channel stringProxy Host - 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 string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Retry
Count float64 Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- Ssl
Enable bool - Specifies whether to enable two-way authentication, defaults to false.
- Timeout float64
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - Version string
- Specifies the version of the FunctionGraph function.
- Vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - Vpc
Channel stringProxy Host - 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 String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count Double Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- ssl
Enable Boolean - Specifies whether to enable two-way authentication, defaults to false.
- timeout Double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain String - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - version String
- Specifies the version of the FunctionGraph function.
- vpc
Channel StringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel StringProxy Host - 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 string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count number Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- ssl
Enable boolean - Specifies whether to enable two-way authentication, defaults to false.
- timeout number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - version string
- Specifies the version of the FunctionGraph function.
- vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel stringProxy Host - 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 values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request_
uri str - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - request_
protocol str - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry_
count float Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- ssl_
enable bool - Specifies whether to enable two-way authentication, defaults to false.
- timeout float
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url_
domain str - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - version str
- Specifies the version of the FunctionGraph function.
- vpc_
channel_ strid - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc_
channel_ strproxy_ host - 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 String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count Number Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- ssl
Enable Boolean - Specifies whether to enable two-way authentication, defaults to false.
- timeout Number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain String - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - version String
- Specifies the version of the FunctionGraph function.
- vpc
Channel StringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel StringProxy Host - 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.
ApigwApiV2HttpPolicy, ApigwApiV2HttpPolicyArgs
- Conditions
List<Apigw
Api V2Http Policy Condition> - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params List<ApigwApi V2Http Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Retry
Count double Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- Timeout double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - Vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - Vpc
Channel stringProxy Host - 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.
- Conditions
[]Apigw
Api V2Http Policy Condition - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - Request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params []ApigwApi V2Http Policy Backend Param - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - Retry
Count float64 Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- Timeout float64
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - Url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - Vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - Vpc
Channel stringProxy Host - 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.
- conditions
List<Apigw
Api V2Http Policy Condition> - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params List<ApigwApi V2Http Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count Double Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- timeout Double
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain String - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - vpc
Channel StringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel StringProxy Host - 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.
- conditions
Apigw
Api V2Http Policy Condition[] - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - request
Method string - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri string - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params ApigwApi V2Http Policy Backend Param[] - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - request
Protocol string - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count number Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- timeout number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain string - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - vpc
Channel stringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel stringProxy Host - 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.
- conditions
Sequence[Apigw
Api V2Http Policy Condition] - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - request_
method str - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request_
uri str - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend_
params Sequence[ApigwApi V2Http Policy Backend Param] - 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
ALLandANY, defaults toANY. - request_
protocol str - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry_
count float Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- timeout float
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url_
domain str - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - vpc_
channel_ strid - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc_
channel_ strproxy_ host - 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.
- 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - request
Method String - Specifies the backend request method of the API.
The valid values are
GET,POST,PUT,DELETE,HEAD,PATCH,OPTIONSandANY. - request
Uri String - Specifies the backend request address, which can contain a maximum of
512characters and must comply with URI specifications.- The address can contain 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
3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed in environment variables.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params 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.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - request
Protocol String - Specifies the backend request protocol. The valid values are
HTTPandHTTPS, defaults toHTTPS. - retry
Count Number Specifies the number of retry attempts to request the backend service. The valid value ranges from
-1to10, defaults to-1.-1indicates that idempotent APIs will retry once and non-idempotent APIs will not retry.POSTandPATCHare not-idempotent.GET,HEAD,PUT,OPTIONSandDELETEare idempotent.When the (web) backend uses the channel, the
retry_countmust be less than the number of available backend servers in the channel.- timeout Number
- Specifies the timeout, in ms, which allowed for APIGW to request the backend service. The
valid value is range from
1to600,000, defaults to5,000. - url
Domain String - Specifies the backend service address.
The value which consists of a domain name or IP address, and a port number, with not more than
255characters. 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 port443, or the default HTTP port80is used. The backend service address can contain environment variables, each starting with a letter and consisting of3to32characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. - vpc
Channel StringId - Specifies the VPC channel ID.
This parameter and
url_domainare alternative. - vpc
Channel StringProxy Host - 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.
ApigwApiV2HttpPolicyBackendParam, ApigwApiV2HttpPolicyBackendParamArgs
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location str
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system_
param_ strtype Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
ApigwApiV2HttpPolicyCondition, ApigwApiV2HttpPolicyConditionArgs
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin str
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param_
name str - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
ApigwApiV2Mock, ApigwApiV2MockArgs
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - Version string
- Specifies the version of the FunctionGraph function.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - Version string
- Specifies the version of the FunctionGraph function.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - response String
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - version String
- Specifies the version of the FunctionGraph function.
- string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - version string
- Specifies the version of the FunctionGraph function.
- str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - response str
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - version str
- Specifies the version of the FunctionGraph function.
- String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - response String
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed. - version String
- Specifies the version of the FunctionGraph function.
ApigwApiV2MockPolicy, ApigwApiV2MockPolicyArgs
- Conditions
List<Apigw
Api V2Mock Policy Condition> - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params List<ApigwApi V2Mock Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed.
- Conditions
[]Apigw
Api V2Mock Policy Condition - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- Backend
Params []ApigwApi V2Mock Policy Backend Param - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- Effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - Response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed.
- conditions
List<Apigw
Api V2Mock Policy Condition> - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params List<ApigwApi V2Mock Policy Backend Param> - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - response String
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed.
- conditions
Apigw
Api V2Mock Policy Condition[] - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - string
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params ApigwApi V2Mock Policy Backend Param[] - Specifies an array of one or more backend parameters. The maximum of request parameters is 50. The object structure is documented above.
- effective
Mode string - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - response string
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed.
- conditions
Sequence[Apigw
Api V2Mock Policy Condition] - 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - str
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend_
params Sequence[ApigwApi V2Mock Policy Backend Param] - 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
ALLandANY, defaults toANY. - response str
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters 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.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - String
Specifies the ID of the backend custom authorization.
The
conditionsblock supports:- backend
Params 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.
- effective
Mode String - Specifies the effective mode of the backend policy. The valid values are
ALLandANY, defaults toANY. - response String
- Specifies the response of the backend policy.
The description contains a maximum of
2,048characters and the angle brackets (< and >) are not allowed.
ApigwApiV2MockPolicyBackendParam, ApigwApiV2MockPolicyBackendParamArgs
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - System
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param stringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location str
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system_
param_ strtype Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
- location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - system
Param StringType Specifies the type of the system parameter. The valid values are
frontend,backendandinternal, defaults tointernal.The
mockblock supports:
ApigwApiV2MockPolicyCondition, ApigwApiV2MockPolicyConditionArgs
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- Value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- Origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - Param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value string
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin string
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name string - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value str
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin str
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param_
name str - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
- value String
Specifies the value of the backend policy. For a condition with the input parameter source:
- If the condition type is
ENUM, separate condition values with commas. - If the condition type is
PATTERN, 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.
- If the condition type is
- origin String
- Specifies the backend policy type.
The valid values are
param,source, defaults tosource. - param
Name String - Specifies the request parameter name.
This parameter is required if the policy type is
param. The valid values areuser_ageandX-TEST-ENUM. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT.
ApigwApiV2RequestParam, ApigwApiV2RequestParamArgs
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Default string
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Enumeration string
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- Passthrough bool
- Specifies whether to transparently transfer the parameter.
- Required bool
- Specifies whether the request parameter is required.
- Sample string
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Validity
Check bool
- Name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - Default string
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Enumeration string
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - Location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- Passthrough bool
- Specifies whether to transparently transfer the parameter.
- Required bool
- Specifies whether the request parameter is required.
- Sample string
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - Type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - Validity
Check bool
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - default_ String
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - enumeration String
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- passthrough Boolean
- Specifies whether to transparently transfer the parameter.
- required Boolean
- Specifies whether the request parameter is required.
- sample String
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - validity
Check Boolean
- name string
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - default string
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - description string
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - enumeration string
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - location string
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- passthrough boolean
- Specifies whether to transparently transfer the parameter.
- required boolean
- Specifies whether the request parameter is required.
- sample string
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - type string
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - validity
Check boolean
- name str
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - default str
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - description str
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - enumeration str
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - location str
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- passthrough bool
- Specifies whether to transparently transfer the parameter.
- required bool
- Specifies whether the request parameter is required.
- sample str
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - type str
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - validity_
check bool
- name String
- Specifies the backend policy name.
The valid length is limited from can contain
3to64, only letters, digits and underscores (_) are allowed. - default String
- Specifies the default value of the request parameter.
The value contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - description String
- Specifies the description of the constant or system parameter.
The description contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - enumeration String
- Specifies the enumerated value(s).
Use commas to separate multiple enumeration values, such as
VALUE_A,VALUE_B. - location String
- Specifies the location of the backend parameter.
The valid values are
PATH,QUERYandHEADER. - 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
maximumandminimummeans size. For number type, they means value.- passthrough Boolean
- Specifies whether to transparently transfer the parameter.
- required Boolean
- Specifies whether the request parameter is required.
- sample String
- Specifies the example value of the request parameter.
The example contains a maximum of
255characters and the angle brackets (< and >) are not allowed. - type String
- Specifies the condition type of the backend policy.
The valid values are
EXACT,ENUMandPATTERN, defaults toEXACT. - validity
Check Boolean
Import
API can be imported using the id, e.g.
$ pulumi import opentelekomcloud:index/apigwApiV2:ApigwApiV2 api "774438a28a574ac8a496325d1bf51807"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
- License
- Notes
- This Pulumi package is based on the
opentelekomcloudTerraform Provider.
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud