Docs Home
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleengine.ApiGatewayApi
Explore with Pulumi AI
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
Provides an API gateway API resource within FlexibleEngine.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";
const apigwGroup = new flexibleengine.ApiGatewayGroup("apigwGroup", {description: "your descpiption"});
const apigwApi = new flexibleengine.ApiGatewayApi("apigwApi", {
groupId: apigwGroup.apiGatewayGroupId,
description: "your descpiption",
tags: [
"tag1",
"tag2",
],
visibility: 1,
authType: "IAM",
backendType: "HTTP",
requestProtocol: "HTTPS",
requestMethod: "GET",
requestUri: "/test/path1",
exampleSuccessResponse: "example response",
httpBackend: {
protocol: "HTTPS",
method: "GET",
uri: "/web/openapi",
urlDomain: "backenddomain.com",
timeout: 10000,
},
});
import pulumi
import pulumi_flexibleengine as flexibleengine
apigw_group = flexibleengine.ApiGatewayGroup("apigwGroup", description="your descpiption")
apigw_api = flexibleengine.ApiGatewayApi("apigwApi",
group_id=apigw_group.api_gateway_group_id,
description="your descpiption",
tags=[
"tag1",
"tag2",
],
visibility=1,
auth_type="IAM",
backend_type="HTTP",
request_protocol="HTTPS",
request_method="GET",
request_uri="/test/path1",
example_success_response="example response",
http_backend={
"protocol": "HTTPS",
"method": "GET",
"uri": "/web/openapi",
"url_domain": "backenddomain.com",
"timeout": 10000,
})
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
apigwGroup, err := flexibleengine.NewApiGatewayGroup(ctx, "apigwGroup", &flexibleengine.ApiGatewayGroupArgs{
Description: pulumi.String("your descpiption"),
})
if err != nil {
return err
}
_, err = flexibleengine.NewApiGatewayApi(ctx, "apigwApi", &flexibleengine.ApiGatewayApiArgs{
GroupId: apigwGroup.ApiGatewayGroupId,
Description: pulumi.String("your descpiption"),
Tags: pulumi.StringArray{
pulumi.String("tag1"),
pulumi.String("tag2"),
},
Visibility: pulumi.Float64(1),
AuthType: pulumi.String("IAM"),
BackendType: pulumi.String("HTTP"),
RequestProtocol: pulumi.String("HTTPS"),
RequestMethod: pulumi.String("GET"),
RequestUri: pulumi.String("/test/path1"),
ExampleSuccessResponse: pulumi.String("example response"),
HttpBackend: &flexibleengine.ApiGatewayApiHttpBackendArgs{
Protocol: pulumi.String("HTTPS"),
Method: pulumi.String("GET"),
Uri: pulumi.String("/web/openapi"),
UrlDomain: pulumi.String("backenddomain.com"),
Timeout: pulumi.Float64(10000),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;
return await Deployment.RunAsync(() =>
{
var apigwGroup = new Flexibleengine.ApiGatewayGroup("apigwGroup", new()
{
Description = "your descpiption",
});
var apigwApi = new Flexibleengine.ApiGatewayApi("apigwApi", new()
{
GroupId = apigwGroup.ApiGatewayGroupId,
Description = "your descpiption",
Tags = new[]
{
"tag1",
"tag2",
},
Visibility = 1,
AuthType = "IAM",
BackendType = "HTTP",
RequestProtocol = "HTTPS",
RequestMethod = "GET",
RequestUri = "/test/path1",
ExampleSuccessResponse = "example response",
HttpBackend = new Flexibleengine.Inputs.ApiGatewayApiHttpBackendArgs
{
Protocol = "HTTPS",
Method = "GET",
Uri = "/web/openapi",
UrlDomain = "backenddomain.com",
Timeout = 10000,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApiGatewayGroup;
import com.pulumi.flexibleengine.ApiGatewayGroupArgs;
import com.pulumi.flexibleengine.ApiGatewayApi;
import com.pulumi.flexibleengine.ApiGatewayApiArgs;
import com.pulumi.flexibleengine.inputs.ApiGatewayApiHttpBackendArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var apigwGroup = new ApiGatewayGroup("apigwGroup", ApiGatewayGroupArgs.builder()
.description("your descpiption")
.build());
var apigwApi = new ApiGatewayApi("apigwApi", ApiGatewayApiArgs.builder()
.groupId(apigwGroup.apiGatewayGroupId())
.description("your descpiption")
.tags(
"tag1",
"tag2")
.visibility(1)
.authType("IAM")
.backendType("HTTP")
.requestProtocol("HTTPS")
.requestMethod("GET")
.requestUri("/test/path1")
.exampleSuccessResponse("example response")
.httpBackend(ApiGatewayApiHttpBackendArgs.builder()
.protocol("HTTPS")
.method("GET")
.uri("/web/openapi")
.urlDomain("backenddomain.com")
.timeout(10000)
.build())
.build());
}
}
resources:
apigwGroup:
type: flexibleengine:ApiGatewayGroup
properties:
description: your descpiption
apigwApi:
type: flexibleengine:ApiGatewayApi
properties:
groupId: ${apigwGroup.apiGatewayGroupId}
description: your descpiption
tags:
- tag1
- tag2
visibility: 1
authType: IAM
backendType: HTTP
requestProtocol: HTTPS
requestMethod: GET
requestUri: /test/path1
exampleSuccessResponse: example response
httpBackend:
protocol: HTTPS
method: GET
uri: /web/openapi
urlDomain: backenddomain.com
timeout: 10000
Create ApiGatewayApi Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApiGatewayApi(name: string, args: ApiGatewayApiArgs, opts?: CustomResourceOptions);@overload
def ApiGatewayApi(resource_name: str,
args: ApiGatewayApiArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApiGatewayApi(resource_name: str,
opts: Optional[ResourceOptions] = None,
example_success_response: Optional[str] = None,
auth_type: Optional[str] = None,
request_uri: Optional[str] = None,
backend_type: Optional[str] = None,
request_method: Optional[str] = None,
group_id: Optional[str] = None,
http_backend: Optional[ApiGatewayApiHttpBackendArgs] = None,
region: Optional[str] = None,
function_backend: Optional[ApiGatewayApiFunctionBackendArgs] = None,
description: Optional[str] = None,
api_gateway_api_id: Optional[str] = None,
mock_backend: Optional[ApiGatewayApiMockBackendArgs] = None,
name: Optional[str] = None,
example_failure_response: Optional[str] = None,
cors: Optional[bool] = None,
request_parameters: Optional[Sequence[ApiGatewayApiRequestParameterArgs]] = None,
request_protocol: Optional[str] = None,
backend_parameters: Optional[Sequence[ApiGatewayApiBackendParameterArgs]] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ApiGatewayApiTimeoutsArgs] = None,
version: Optional[str] = None,
visibility: Optional[float] = None)func NewApiGatewayApi(ctx *Context, name string, args ApiGatewayApiArgs, opts ...ResourceOption) (*ApiGatewayApi, error)public ApiGatewayApi(string name, ApiGatewayApiArgs args, CustomResourceOptions? opts = null)
public ApiGatewayApi(String name, ApiGatewayApiArgs args)
public ApiGatewayApi(String name, ApiGatewayApiArgs args, CustomResourceOptions options)
type: flexibleengine:ApiGatewayApi
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 ApiGatewayApiArgs
- 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 ApiGatewayApiArgs
- 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 ApiGatewayApiArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ApiGatewayApiArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ApiGatewayApiArgs
- 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 apiGatewayApiResource = new Flexibleengine.ApiGatewayApi("apiGatewayApiResource", new()
{
ExampleSuccessResponse = "string",
AuthType = "string",
RequestUri = "string",
BackendType = "string",
RequestMethod = "string",
GroupId = "string",
HttpBackend = new Flexibleengine.Inputs.ApiGatewayApiHttpBackendArgs
{
Method = "string",
Protocol = "string",
Uri = "string",
Timeout = 0,
UrlDomain = "string",
VpcChannel = "string",
},
Region = "string",
FunctionBackend = new Flexibleengine.Inputs.ApiGatewayApiFunctionBackendArgs
{
FunctionUrn = "string",
InvocationType = "string",
Version = "string",
Timeout = 0,
},
Description = "string",
ApiGatewayApiId = "string",
MockBackend = new Flexibleengine.Inputs.ApiGatewayApiMockBackendArgs
{
Description = "string",
ResultContent = "string",
Version = "string",
},
Name = "string",
ExampleFailureResponse = "string",
Cors = false,
RequestParameters = new[]
{
new Flexibleengine.Inputs.ApiGatewayApiRequestParameterArgs
{
Location = "string",
Name = "string",
Required = false,
Type = "string",
Default = "string",
Description = "string",
},
},
RequestProtocol = "string",
BackendParameters = new[]
{
new Flexibleengine.Inputs.ApiGatewayApiBackendParameterArgs
{
Location = "string",
Name = "string",
Value = "string",
Description = "string",
Type = "string",
},
},
Tags = new[]
{
"string",
},
Timeouts = new Flexibleengine.Inputs.ApiGatewayApiTimeoutsArgs
{
Create = "string",
Delete = "string",
},
Version = "string",
Visibility = 0,
});
example, err := flexibleengine.NewApiGatewayApi(ctx, "apiGatewayApiResource", &flexibleengine.ApiGatewayApiArgs{
ExampleSuccessResponse: pulumi.String("string"),
AuthType: pulumi.String("string"),
RequestUri: pulumi.String("string"),
BackendType: pulumi.String("string"),
RequestMethod: pulumi.String("string"),
GroupId: pulumi.String("string"),
HttpBackend: &flexibleengine.ApiGatewayApiHttpBackendArgs{
Method: pulumi.String("string"),
Protocol: pulumi.String("string"),
Uri: pulumi.String("string"),
Timeout: pulumi.Float64(0),
UrlDomain: pulumi.String("string"),
VpcChannel: pulumi.String("string"),
},
Region: pulumi.String("string"),
FunctionBackend: &flexibleengine.ApiGatewayApiFunctionBackendArgs{
FunctionUrn: pulumi.String("string"),
InvocationType: pulumi.String("string"),
Version: pulumi.String("string"),
Timeout: pulumi.Float64(0),
},
Description: pulumi.String("string"),
ApiGatewayApiId: pulumi.String("string"),
MockBackend: &flexibleengine.ApiGatewayApiMockBackendArgs{
Description: pulumi.String("string"),
ResultContent: pulumi.String("string"),
Version: pulumi.String("string"),
},
Name: pulumi.String("string"),
ExampleFailureResponse: pulumi.String("string"),
Cors: pulumi.Bool(false),
RequestParameters: flexibleengine.ApiGatewayApiRequestParameterArray{
&flexibleengine.ApiGatewayApiRequestParameterArgs{
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Required: pulumi.Bool(false),
Type: pulumi.String("string"),
Default: pulumi.String("string"),
Description: pulumi.String("string"),
},
},
RequestProtocol: pulumi.String("string"),
BackendParameters: flexibleengine.ApiGatewayApiBackendParameterArray{
&flexibleengine.ApiGatewayApiBackendParameterArgs{
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Value: pulumi.String("string"),
Description: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &flexibleengine.ApiGatewayApiTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
},
Version: pulumi.String("string"),
Visibility: pulumi.Float64(0),
})
var apiGatewayApiResource = new ApiGatewayApi("apiGatewayApiResource", ApiGatewayApiArgs.builder()
.exampleSuccessResponse("string")
.authType("string")
.requestUri("string")
.backendType("string")
.requestMethod("string")
.groupId("string")
.httpBackend(ApiGatewayApiHttpBackendArgs.builder()
.method("string")
.protocol("string")
.uri("string")
.timeout(0)
.urlDomain("string")
.vpcChannel("string")
.build())
.region("string")
.functionBackend(ApiGatewayApiFunctionBackendArgs.builder()
.functionUrn("string")
.invocationType("string")
.version("string")
.timeout(0)
.build())
.description("string")
.apiGatewayApiId("string")
.mockBackend(ApiGatewayApiMockBackendArgs.builder()
.description("string")
.resultContent("string")
.version("string")
.build())
.name("string")
.exampleFailureResponse("string")
.cors(false)
.requestParameters(ApiGatewayApiRequestParameterArgs.builder()
.location("string")
.name("string")
.required(false)
.type("string")
.default_("string")
.description("string")
.build())
.requestProtocol("string")
.backendParameters(ApiGatewayApiBackendParameterArgs.builder()
.location("string")
.name("string")
.value("string")
.description("string")
.type("string")
.build())
.tags("string")
.timeouts(ApiGatewayApiTimeoutsArgs.builder()
.create("string")
.delete("string")
.build())
.version("string")
.visibility(0)
.build());
api_gateway_api_resource = flexibleengine.ApiGatewayApi("apiGatewayApiResource",
example_success_response="string",
auth_type="string",
request_uri="string",
backend_type="string",
request_method="string",
group_id="string",
http_backend={
"method": "string",
"protocol": "string",
"uri": "string",
"timeout": 0,
"url_domain": "string",
"vpc_channel": "string",
},
region="string",
function_backend={
"function_urn": "string",
"invocation_type": "string",
"version": "string",
"timeout": 0,
},
description="string",
api_gateway_api_id="string",
mock_backend={
"description": "string",
"result_content": "string",
"version": "string",
},
name="string",
example_failure_response="string",
cors=False,
request_parameters=[{
"location": "string",
"name": "string",
"required": False,
"type": "string",
"default": "string",
"description": "string",
}],
request_protocol="string",
backend_parameters=[{
"location": "string",
"name": "string",
"value": "string",
"description": "string",
"type": "string",
}],
tags=["string"],
timeouts={
"create": "string",
"delete": "string",
},
version="string",
visibility=0)
const apiGatewayApiResource = new flexibleengine.ApiGatewayApi("apiGatewayApiResource", {
exampleSuccessResponse: "string",
authType: "string",
requestUri: "string",
backendType: "string",
requestMethod: "string",
groupId: "string",
httpBackend: {
method: "string",
protocol: "string",
uri: "string",
timeout: 0,
urlDomain: "string",
vpcChannel: "string",
},
region: "string",
functionBackend: {
functionUrn: "string",
invocationType: "string",
version: "string",
timeout: 0,
},
description: "string",
apiGatewayApiId: "string",
mockBackend: {
description: "string",
resultContent: "string",
version: "string",
},
name: "string",
exampleFailureResponse: "string",
cors: false,
requestParameters: [{
location: "string",
name: "string",
required: false,
type: "string",
"default": "string",
description: "string",
}],
requestProtocol: "string",
backendParameters: [{
location: "string",
name: "string",
value: "string",
description: "string",
type: "string",
}],
tags: ["string"],
timeouts: {
create: "string",
"delete": "string",
},
version: "string",
visibility: 0,
});
type: flexibleengine:ApiGatewayApi
properties:
apiGatewayApiId: string
authType: string
backendParameters:
- description: string
location: string
name: string
type: string
value: string
backendType: string
cors: false
description: string
exampleFailureResponse: string
exampleSuccessResponse: string
functionBackend:
functionUrn: string
invocationType: string
timeout: 0
version: string
groupId: string
httpBackend:
method: string
protocol: string
timeout: 0
uri: string
urlDomain: string
vpcChannel: string
mockBackend:
description: string
resultContent: string
version: string
name: string
region: string
requestMethod: string
requestParameters:
- default: string
description: string
location: string
name: string
required: false
type: string
requestProtocol: string
requestUri: string
tags:
- string
timeouts:
create: string
delete: string
version: string
visibility: 0
ApiGatewayApi 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 ApiGatewayApi resource accepts the following input properties:
- Auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- Backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- Example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- Group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- Request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- Request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- Api
Gateway stringApi Id - The ID of the API.
- Backend
Parameters List<ApiGateway Api Backend Parameter> - the backend parameter list (documented below).
- Cors bool
- Specifies whether CORS is supported or not.
- Description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- Example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- Function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- Http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- Mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- Name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- Region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- Request
Parameters List<ApiGateway Api Request Parameter> - the request parameter list (documented below).
- Request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- List<string>
- the tags of API in format of string list.
- Timeouts
Api
Gateway Api Timeouts - Version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- Visibility double
- Specifies whether the API is available to the public. The value can only be 1 (public).
- Auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- Backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- Example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- Group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- Request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- Request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- Api
Gateway stringApi Id - The ID of the API.
- Backend
Parameters []ApiGateway Api Backend Parameter Args - the backend parameter list (documented below).
- Cors bool
- Specifies whether CORS is supported or not.
- Description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- Example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- Function
Backend ApiGateway Api Function Backend Args - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- Http
Backend ApiGateway Api Http Backend Args - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- Mock
Backend ApiGateway Api Mock Backend Args - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- Name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- Region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- Request
Parameters []ApiGateway Api Request Parameter Args - the request parameter list (documented below).
- Request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- []string
- the tags of API in format of string list.
- Timeouts
Api
Gateway Api Timeouts Args - Version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- Visibility float64
- Specifies whether the API is available to the public. The value can only be 1 (public).
- auth
Type String - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Type String - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- example
Success StringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- group
Id String - Specifies the ID of the API group. Changing this creates a new resource.
- request
Method String - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Uri String - Specifies the request path of the API. The value must comply with URI specifications.
- api
Gateway StringApi Id - The ID of the API.
- backend
Parameters List<ApiGateway Api Backend Parameter> - the backend parameter list (documented below).
- cors Boolean
- Specifies whether CORS is supported or not.
- description String
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure StringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name String
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region String
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Parameters List<ApiGateway Api Request Parameter> - the request parameter list (documented below).
- request
Protocol String - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- List<String>
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts - version String
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility Double
- Specifies whether the API is available to the public. The value can only be 1 (public).
- auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- api
Gateway stringApi Id - The ID of the API.
- backend
Parameters ApiGateway Api Backend Parameter[] - the backend parameter list (documented below).
- cors boolean
- Specifies whether CORS is supported or not.
- description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Parameters ApiGateway Api Request Parameter[] - the request parameter list (documented below).
- request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- string[]
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts - version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility number
- Specifies whether the API is available to the public. The value can only be 1 (public).
- auth_
type str - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend_
type str - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- example_
success_ strresponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- group_
id str - Specifies the ID of the API group. Changing this creates a new resource.
- request_
method str - Specifies the request method, including 'GET','POST','PUT' and etc..
- request_
uri str - Specifies the request path of the API. The value must comply with URI specifications.
- api_
gateway_ strapi_ id - The ID of the API.
- backend_
parameters Sequence[ApiGateway Api Backend Parameter Args] - the backend parameter list (documented below).
- cors bool
- Specifies whether CORS is supported or not.
- description str
- Specifies the description of the API. The description cannot exceed 255 characters.
- example_
failure_ strresponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- function_
backend ApiGateway Api Function Backend Args - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- http_
backend ApiGateway Api Http Backend Args - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock_
backend ApiGateway Api Mock Backend Args - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name str
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region str
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request_
parameters Sequence[ApiGateway Api Request Parameter Args] - the request parameter list (documented below).
- request_
protocol str - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- Sequence[str]
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts Args - version str
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility float
- Specifies whether the API is available to the public. The value can only be 1 (public).
- auth
Type String - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Type String - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- example
Success StringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- group
Id String - Specifies the ID of the API group. Changing this creates a new resource.
- request
Method String - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Uri String - Specifies the request path of the API. The value must comply with URI specifications.
- api
Gateway StringApi Id - The ID of the API.
- backend
Parameters List<Property Map> - the backend parameter list (documented below).
- cors Boolean
- Specifies whether CORS is supported or not.
- description String
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure StringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- function
Backend Property Map - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- http
Backend Property Map - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend Property Map - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name String
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region String
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Parameters List<Property Map> - the request parameter list (documented below).
- request
Protocol String - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- List<String>
- the tags of API in format of string list.
- timeouts Property Map
- version String
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility Number
- Specifies whether the API is available to the public. The value can only be 1 (public).
Outputs
All input properties are implicitly available as output properties. Additionally, the ApiGatewayApi resource produces the following output properties:
- group_
name str - The name of the API group to which the API belongs.
- id str
- The provider-assigned unique ID for this managed resource.
Look up Existing ApiGatewayApi Resource
Get an existing ApiGatewayApi 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?: ApiGatewayApiState, opts?: CustomResourceOptions): ApiGatewayApi@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_gateway_api_id: Optional[str] = None,
auth_type: Optional[str] = None,
backend_parameters: Optional[Sequence[ApiGatewayApiBackendParameterArgs]] = None,
backend_type: Optional[str] = None,
cors: Optional[bool] = None,
description: Optional[str] = None,
example_failure_response: Optional[str] = None,
example_success_response: Optional[str] = None,
function_backend: Optional[ApiGatewayApiFunctionBackendArgs] = None,
group_id: Optional[str] = None,
group_name: Optional[str] = None,
http_backend: Optional[ApiGatewayApiHttpBackendArgs] = None,
mock_backend: Optional[ApiGatewayApiMockBackendArgs] = None,
name: Optional[str] = None,
region: Optional[str] = None,
request_method: Optional[str] = None,
request_parameters: Optional[Sequence[ApiGatewayApiRequestParameterArgs]] = None,
request_protocol: Optional[str] = None,
request_uri: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ApiGatewayApiTimeoutsArgs] = None,
version: Optional[str] = None,
visibility: Optional[float] = None) -> ApiGatewayApifunc GetApiGatewayApi(ctx *Context, name string, id IDInput, state *ApiGatewayApiState, opts ...ResourceOption) (*ApiGatewayApi, error)public static ApiGatewayApi Get(string name, Input<string> id, ApiGatewayApiState? state, CustomResourceOptions? opts = null)public static ApiGatewayApi get(String name, Output<String> id, ApiGatewayApiState state, CustomResourceOptions options)resources: _: type: flexibleengine:ApiGatewayApi 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.
- Api
Gateway stringApi Id - The ID of the API.
- Auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- Backend
Parameters List<ApiGateway Api Backend Parameter> - the backend parameter list (documented below).
- Backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- Cors bool
- Specifies whether CORS is supported or not.
- Description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- Example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- Example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- Function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- Group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- Group
Name string - The name of the API group to which the API belongs.
- Http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- Mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- Name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- Region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- Request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- Request
Parameters List<ApiGateway Api Request Parameter> - the request parameter list (documented below).
- Request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- Request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- List<string>
- the tags of API in format of string list.
- Timeouts
Api
Gateway Api Timeouts - Version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- Visibility double
- Specifies whether the API is available to the public. The value can only be 1 (public).
- Api
Gateway stringApi Id - The ID of the API.
- Auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- Backend
Parameters []ApiGateway Api Backend Parameter Args - the backend parameter list (documented below).
- Backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- Cors bool
- Specifies whether CORS is supported or not.
- Description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- Example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- Example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- Function
Backend ApiGateway Api Function Backend Args - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- Group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- Group
Name string - The name of the API group to which the API belongs.
- Http
Backend ApiGateway Api Http Backend Args - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- Mock
Backend ApiGateway Api Mock Backend Args - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- Name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- Region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- Request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- Request
Parameters []ApiGateway Api Request Parameter Args - the request parameter list (documented below).
- Request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- Request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- []string
- the tags of API in format of string list.
- Timeouts
Api
Gateway Api Timeouts Args - Version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- Visibility float64
- Specifies whether the API is available to the public. The value can only be 1 (public).
- api
Gateway StringApi Id - The ID of the API.
- auth
Type String - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Parameters List<ApiGateway Api Backend Parameter> - the backend parameter list (documented below).
- backend
Type String - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- cors Boolean
- Specifies whether CORS is supported or not.
- description String
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure StringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- example
Success StringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- group
Id String - Specifies the ID of the API group. Changing this creates a new resource.
- group
Name String - The name of the API group to which the API belongs.
- http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name String
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region String
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Method String - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Parameters List<ApiGateway Api Request Parameter> - the request parameter list (documented below).
- request
Protocol String - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- request
Uri String - Specifies the request path of the API. The value must comply with URI specifications.
- List<String>
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts - version String
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility Double
- Specifies whether the API is available to the public. The value can only be 1 (public).
- api
Gateway stringApi Id - The ID of the API.
- auth
Type string - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Parameters ApiGateway Api Backend Parameter[] - the backend parameter list (documented below).
- backend
Type string - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- cors boolean
- Specifies whether CORS is supported or not.
- description string
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure stringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- example
Success stringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- function
Backend ApiGateway Api Function Backend - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- group
Id string - Specifies the ID of the API group. Changing this creates a new resource.
- group
Name string - The name of the API group to which the API belongs.
- http
Backend ApiGateway Api Http Backend - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend ApiGateway Api Mock Backend - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name string
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region string
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Method string - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Parameters ApiGateway Api Request Parameter[] - the request parameter list (documented below).
- request
Protocol string - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- request
Uri string - Specifies the request path of the API. The value must comply with URI specifications.
- string[]
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts - version string
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility number
- Specifies whether the API is available to the public. The value can only be 1 (public).
- api_
gateway_ strapi_ id - The ID of the API.
- auth_
type str - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend_
parameters Sequence[ApiGateway Api Backend Parameter Args] - the backend parameter list (documented below).
- backend_
type str - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- cors bool
- Specifies whether CORS is supported or not.
- description str
- Specifies the description of the API. The description cannot exceed 255 characters.
- example_
failure_ strresponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- example_
success_ strresponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- function_
backend ApiGateway Api Function Backend Args - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- group_
id str - Specifies the ID of the API group. Changing this creates a new resource.
- group_
name str - The name of the API group to which the API belongs.
- http_
backend ApiGateway Api Http Backend Args - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock_
backend ApiGateway Api Mock Backend Args - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name str
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region str
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request_
method str - Specifies the request method, including 'GET','POST','PUT' and etc..
- request_
parameters Sequence[ApiGateway Api Request Parameter Args] - the request parameter list (documented below).
- request_
protocol str - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- request_
uri str - Specifies the request path of the API. The value must comply with URI specifications.
- Sequence[str]
- the tags of API in format of string list.
- timeouts
Api
Gateway Api Timeouts Args - version str
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility float
- Specifies whether the API is available to the public. The value can only be 1 (public).
- api
Gateway StringApi Id - The ID of the API.
- auth
Type String - Specifies the security authentication mode. The value can be 'APP', 'IAM', and ' NONE'.
- backend
Parameters List<Property Map> - the backend parameter list (documented below).
- backend
Type String - Specifies the service backend type. The value can be:
- 'HTTP': the web service backend
- 'FUNCTION': the FunctionGraph service backend
- 'MOCK': the Mock service backend
- cors Boolean
- Specifies whether CORS is supported or not.
- description String
- Specifies the description of the API. The description cannot exceed 255 characters.
- example
Failure StringResponse - Specifies the example response for a failed request The length cannot exceed 20,480 characters.
- example
Success StringResponse - Specifies the example response for a successful request. The length cannot exceed 20,480 characters.
- function
Backend Property Map - Specifies the configuration when backend_type selected 'FUNCTION' (documented below).
- group
Id String - Specifies the ID of the API group. Changing this creates a new resource.
- group
Name String - The name of the API group to which the API belongs.
- http
Backend Property Map - Specifies the configuration when backend_type selected 'HTTP' (documented below).
- mock
Backend Property Map - Specifies the configuration when backend_type selected 'MOCK' (documented below).
- name String
- Specifies the name of the API. An API name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
- region String
- The region in which to create the API resource. If omitted, the provider-level region will be used. Changing this creates a new API resource.
- request
Method String - Specifies the request method, including 'GET','POST','PUT' and etc..
- request
Parameters List<Property Map> - the request parameter list (documented below).
- request
Protocol String - Specifies the request protocol. The value can be 'HTTP', 'HTTPS', and 'BOTH' which means the API can be accessed through both 'HTTP' and 'HTTPS'. Defaults to 'HTTPS'.
- request
Uri String - Specifies the request path of the API. The value must comply with URI specifications.
- List<String>
- the tags of API in format of string list.
- timeouts Property Map
- version String
- Specifies the version of the API. A maximum of 16 characters are allowed.
- visibility Number
- Specifies whether the API is available to the public. The value can only be 1 (public).
Supporting Types
ApiGatewayApiBackendParameter, ApiGatewayApiBackendParameterArgs
- Location string
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- Name string
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- Value string
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- Description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- Type string
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
- Location string
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- Name string
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- Value string
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- Description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- Type string
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
- location String
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name String
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- value String
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- description String
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- type String
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
- location string
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name string
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- value string
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- type string
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
- location str
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name str
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- value str
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- description str
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- type str
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
- location String
- Specifies the parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name String
- Specifies the parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- value String
- Specifies the parameter value, which is a string of not more than 255 characters. The
value varies depending on the parameter type:
- 'REQUEST': parameter name in
request_parameter - 'CONSTANT': real value of the parameter
- 'SYSTEM': gateway parameter name
- 'REQUEST': parameter name in
- description String
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- type String
- Specifies the parameter type, which can be 'REQUEST', 'CONSTANT', or 'SYSTEM'.
ApiGatewayApiFunctionBackend, ApiGatewayApiFunctionBackendArgs
- Function
Urn string - Specifies the function URN.
- Invocation
Type string - Specifies the invocation mode, which can be 'async' or 'sync'.
- Version string
- Specifies the function version.
- Timeout double
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
- Function
Urn string - Specifies the function URN.
- Invocation
Type string - Specifies the invocation mode, which can be 'async' or 'sync'.
- Version string
- Specifies the function version.
- Timeout float64
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
- function
Urn String - Specifies the function URN.
- invocation
Type String - Specifies the invocation mode, which can be 'async' or 'sync'.
- version String
- Specifies the function version.
- timeout Double
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
- function
Urn string - Specifies the function URN.
- invocation
Type string - Specifies the invocation mode, which can be 'async' or 'sync'.
- version string
- Specifies the function version.
- timeout number
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
- function_
urn str - Specifies the function URN.
- invocation_
type str - Specifies the invocation mode, which can be 'async' or 'sync'.
- version str
- Specifies the function version.
- timeout float
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
- function
Urn String - Specifies the function URN.
- invocation
Type String - Specifies the invocation mode, which can be 'async' or 'sync'.
- version String
- Specifies the function version.
- timeout Number
- Timeout duration (in ms) for API Gateway to request for FunctionGraph. Defaults to 50000.
ApiGatewayApiHttpBackend, ApiGatewayApiHttpBackendArgs
- Method string
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- Protocol string
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- Uri string
- Specifies the backend request path. The value must comply with URI specifications.
- Timeout double
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- Url
Domain string - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - Vpc
Channel string - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
- Method string
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- Protocol string
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- Uri string
- Specifies the backend request path. The value must comply with URI specifications.
- Timeout float64
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- Url
Domain string - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - Vpc
Channel string - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
- method String
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- protocol String
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- uri String
- Specifies the backend request path. The value must comply with URI specifications.
- timeout Double
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- url
Domain String - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - vpc
Channel String - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
- method string
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- protocol string
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- uri string
- Specifies the backend request path. The value must comply with URI specifications.
- timeout number
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- url
Domain string - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - vpc
Channel string - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
- method str
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- protocol str
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- uri str
- Specifies the backend request path. The value must comply with URI specifications.
- timeout float
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- url_
domain str - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - vpc_
channel str - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
- method String
- Specifies the backend request method, including 'GET','POST','PUT' and etc..
- protocol String
- Specifies the backend request protocol. The value can be 'HTTP' and 'HTTPS'.
- uri String
- Specifies the backend request path. The value must comply with URI specifications.
- timeout Number
- Timeout duration (in ms) for API Gateway to request for the backend service. Defaults to 50000.
- url
Domain String - Specifies the backend service address. An endpoint URL is in the format of
"domain name (or IP address):port number", with up to 255 characters. This parameter and
vpc_channelare alternative. - vpc
Channel String - Specifies the VPC channel ID. This parameter and
url_domainare alternative.
ApiGatewayApiMockBackend, ApiGatewayApiMockBackendArgs
- Description string
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- Result
Content string - Specifies the return result.
- Version string
- Specifies the version of the Mock backend.
- Description string
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- Result
Content string - Specifies the return result.
- Version string
- Specifies the version of the Mock backend.
- description String
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- result
Content String - Specifies the return result.
- version String
- Specifies the version of the Mock backend.
- description string
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- result
Content string - Specifies the return result.
- version string
- Specifies the version of the Mock backend.
- description str
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- result_
content str - Specifies the return result.
- version str
- Specifies the version of the Mock backend.
- description String
- Specifies the description of the Mock backend. The description cannot exceed 255 characters.
- result
Content String - Specifies the return result.
- version String
- Specifies the version of the Mock backend.
ApiGatewayApiRequestParameter, ApiGatewayApiRequestParameterArgs
- Location string
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- Name string
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- Required bool
- Specifies whether the parameter is mandatory or not.
- Type string
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- Default string
- Specifies the default value when the parameter is optional.
- Description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- Location string
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- Name string
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- Required bool
- Specifies whether the parameter is mandatory or not.
- Type string
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- Default string
- Specifies the default value when the parameter is optional.
- Description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- location String
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name String
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- required Boolean
- Specifies whether the parameter is mandatory or not.
- type String
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- default_ String
- Specifies the default value when the parameter is optional.
- description String
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- location string
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name string
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- required boolean
- Specifies whether the parameter is mandatory or not.
- type string
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- default string
- Specifies the default value when the parameter is optional.
- description string
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- location str
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name str
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- required bool
- Specifies whether the parameter is mandatory or not.
- type str
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- default str
- Specifies the default value when the parameter is optional.
- description str
- Specifies the description of the parameter. The description cannot exceed 255 characters.
- location String
- Specifies the input parameter location, which can be 'PATH', 'QUERY' or 'HEADER'.
- name String
- Specifies the input parameter name. A parameter name consists of 1–32 characters, starting with a letter. Only letters, digits, periods (.), hyphens (-), and underscores (_) are allowed.
- required Boolean
- Specifies whether the parameter is mandatory or not.
- type String
- Specifies the input parameter type, which can be 'STRING' or 'NUMBER'.
- default String
- Specifies the default value when the parameter is optional.
- description String
- Specifies the description of the parameter. The description cannot exceed 255 characters.
ApiGatewayApiTimeouts, ApiGatewayApiTimeoutsArgs
Import
API can be imported using the id, e.g.
$ pulumi import flexibleengine:index/apiGatewayApi:ApiGatewayApi api 774438a28a574ac8a496325d1bf51807
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
- License
- Notes
- This Pulumi package is based on the
flexibleengineTerraform Provider.
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud