Alibaba Cloud

v3.28.0 published on Tuesday, Aug 16, 2022 by Pulumi

Api

Import

Api gateway api can be imported using the id.Format to <API Group Id>:<API Id> e.g.

 $ pulumi import alicloud:apigateway/api:Api example "ab2351f2ce904edaa8d92a0510832b91:e4f728fca5a94148b023b99a3e5d0b62"

Example Usage

Basic Usage

using Pulumi;
using AliCloud = Pulumi.AliCloud;

class MyStack : Stack
{
    public MyStack()
    {
        var apiGroup = new AliCloud.ApiGateway.Group("apiGroup", new AliCloud.ApiGateway.GroupArgs
        {
            Description = "description of the api group",
        });
        var apiGatewayApi = new AliCloud.ApiGateway.Api("apiGatewayApi", new AliCloud.ApiGateway.ApiArgs
        {
            GroupId = apiGroup.Id,
            Description = "your description",
            AuthType = "APP",
            ForceNonceCheck = false,
            RequestConfig = new AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs
            {
                Protocol = "HTTP",
                Method = "GET",
                Path = "/test/path1",
                Mode = "MAPPING",
            },
            ServiceType = "HTTP",
            HttpServiceConfig = new AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs
            {
                Address = "http://apigateway-backend.alicloudapi.com:8080",
                Method = "GET",
                Path = "/web/cloudapi",
                Timeout = 12,
                AoneName = "cloudapi-openapi",
            },
            RequestParameters = 
            {
                new AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs
                {
                    Name = "aaa",
                    Type = "STRING",
                    Required = "OPTIONAL",
                    In = "QUERY",
                    InService = "QUERY",
                    NameService = "testparams",
                },
            },
            StageNames = 
            {
                "RELEASE",
                "TEST",
            },
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		apiGroup, err := apigateway.NewGroup(ctx, "apiGroup", &apigateway.GroupArgs{
			Description: pulumi.String("description of the api group"),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewApi(ctx, "apiGatewayApi", &apigateway.ApiArgs{
			GroupId:         apiGroup.ID(),
			Description:     pulumi.String("your description"),
			AuthType:        pulumi.String("APP"),
			ForceNonceCheck: pulumi.Bool(false),
			RequestConfig: &apigateway.ApiRequestConfigArgs{
				Protocol: pulumi.String("HTTP"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/test/path1"),
				Mode:     pulumi.String("MAPPING"),
			},
			ServiceType: pulumi.String("HTTP"),
			HttpServiceConfig: &apigateway.ApiHttpServiceConfigArgs{
				Address:  pulumi.String("http://apigateway-backend.alicloudapi.com:8080"),
				Method:   pulumi.String("GET"),
				Path:     pulumi.String("/web/cloudapi"),
				Timeout:  pulumi.Int(12),
				AoneName: pulumi.String("cloudapi-openapi"),
			},
			RequestParameters: apigateway.ApiRequestParameterArray{
				&apigateway.ApiRequestParameterArgs{
					Name:        pulumi.String("aaa"),
					Type:        pulumi.String("STRING"),
					Required:    pulumi.String("OPTIONAL"),
					In:          pulumi.String("QUERY"),
					InService:   pulumi.String("QUERY"),
					NameService: pulumi.String("testparams"),
				},
			},
			StageNames: pulumi.StringArray{
				pulumi.String("RELEASE"),
				pulumi.String("TEST"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Group;
import com.pulumi.alicloud.apigateway.GroupArgs;
import com.pulumi.alicloud.apigateway.Api;
import com.pulumi.alicloud.apigateway.ApiArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiHttpServiceConfigArgs;
import com.pulumi.alicloud.apigateway.inputs.ApiRequestParameterArgs;
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 apiGroup = new Group("apiGroup", GroupArgs.builder()        
            .description("description of the api group")
            .build());

        var apiGatewayApi = new Api("apiGatewayApi", ApiArgs.builder()        
            .groupId(apiGroup.id())
            .description("your description")
            .authType("APP")
            .forceNonceCheck(false)
            .requestConfig(ApiRequestConfigArgs.builder()
                .protocol("HTTP")
                .method("GET")
                .path("/test/path1")
                .mode("MAPPING")
                .build())
            .serviceType("HTTP")
            .httpServiceConfig(ApiHttpServiceConfigArgs.builder()
                .address("http://apigateway-backend.alicloudapi.com:8080")
                .method("GET")
                .path("/web/cloudapi")
                .timeout(12)
                .aoneName("cloudapi-openapi")
                .build())
            .requestParameters(ApiRequestParameterArgs.builder()
                .name("aaa")
                .type("STRING")
                .required("OPTIONAL")
                .in("QUERY")
                .inService("QUERY")
                .nameService("testparams")
                .build())
            .stageNames(            
                "RELEASE",
                "TEST")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

api_group = alicloud.apigateway.Group("apiGroup", description="description of the api group")
api_gateway_api = alicloud.apigateway.Api("apiGatewayApi",
    group_id=api_group.id,
    description="your description",
    auth_type="APP",
    force_nonce_check=False,
    request_config=alicloud.apigateway.ApiRequestConfigArgs(
        protocol="HTTP",
        method="GET",
        path="/test/path1",
        mode="MAPPING",
    ),
    service_type="HTTP",
    http_service_config=alicloud.apigateway.ApiHttpServiceConfigArgs(
        address="http://apigateway-backend.alicloudapi.com:8080",
        method="GET",
        path="/web/cloudapi",
        timeout=12,
        aone_name="cloudapi-openapi",
    ),
    request_parameters=[alicloud.apigateway.ApiRequestParameterArgs(
        name="aaa",
        type="STRING",
        required="OPTIONAL",
        in_="QUERY",
        in_service="QUERY",
        name_service="testparams",
    )],
    stage_names=[
        "RELEASE",
        "TEST",
    ])
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const apiGroup = new alicloud.apigateway.Group("apiGroup", {description: "description of the api group"});
const apiGatewayApi = new alicloud.apigateway.Api("apiGatewayApi", {
    groupId: apiGroup.id,
    description: "your description",
    authType: "APP",
    forceNonceCheck: false,
    requestConfig: {
        protocol: "HTTP",
        method: "GET",
        path: "/test/path1",
        mode: "MAPPING",
    },
    serviceType: "HTTP",
    httpServiceConfig: {
        address: "http://apigateway-backend.alicloudapi.com:8080",
        method: "GET",
        path: "/web/cloudapi",
        timeout: 12,
        aoneName: "cloudapi-openapi",
    },
    requestParameters: [{
        name: "aaa",
        type: "STRING",
        required: "OPTIONAL",
        "in": "QUERY",
        inService: "QUERY",
        nameService: "testparams",
    }],
    stageNames: [
        "RELEASE",
        "TEST",
    ],
});
resources:
  apiGroup:
    type: alicloud:apigateway:Group
    properties:
      description: description of the api group
  apiGatewayApi:
    type: alicloud:apigateway:Api
    properties:
      groupId: ${apiGroup.id}
      description: your description
      authType: APP
      forceNonceCheck: false
      requestConfig:
        protocol: HTTP
        method: GET
        path: /test/path1
        mode: MAPPING
      serviceType: HTTP
      httpServiceConfig:
        address: http://apigateway-backend.alicloudapi.com:8080
        method: GET
        path: /web/cloudapi
        timeout: 12
        aoneName: cloudapi-openapi
      requestParameters:
        - name: aaa
          type: STRING
          required: OPTIONAL
          in: QUERY
          inService: QUERY
          nameService: testparams
      stageNames:
        - RELEASE
        - TEST

Create Api Resource

new Api(name: string, args: ApiArgs, opts?: CustomResourceOptions);
@overload
def Api(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        auth_type: Optional[str] = None,
        constant_parameters: Optional[Sequence[ApiConstantParameterArgs]] = None,
        description: Optional[str] = None,
        fc_service_config: Optional[ApiFcServiceConfigArgs] = None,
        force_nonce_check: Optional[bool] = None,
        group_id: Optional[str] = None,
        http_service_config: Optional[ApiHttpServiceConfigArgs] = None,
        http_vpc_service_config: Optional[ApiHttpVpcServiceConfigArgs] = None,
        mock_service_config: Optional[ApiMockServiceConfigArgs] = None,
        name: Optional[str] = None,
        request_config: Optional[ApiRequestConfigArgs] = None,
        request_parameters: Optional[Sequence[ApiRequestParameterArgs]] = None,
        service_type: Optional[str] = None,
        stage_names: Optional[Sequence[str]] = None,
        system_parameters: Optional[Sequence[ApiSystemParameterArgs]] = None)
@overload
def Api(resource_name: str,
        args: ApiArgs,
        opts: Optional[ResourceOptions] = None)
func NewApi(ctx *Context, name string, args ApiArgs, opts ...ResourceOption) (*Api, error)
public Api(string name, ApiArgs args, CustomResourceOptions? opts = null)
public Api(String name, ApiArgs args)
public Api(String name, ApiArgs args, CustomResourceOptions options)
type: alicloud:apigateway:Api
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ApiArgs
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 ApiArgs
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 ApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Api Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Api resource accepts the following input properties:

AuthType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

Description string

The description of Constant parameter.

GroupId string

The api gateway that the api belongs to. Defaults to null.

RequestConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

ServiceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

ConstantParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiConstantParameterArgs>

constant_parameters defines the constant parameters of the api.

FcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

ForceNonceCheck bool

Whether to prevent API replay attack. Default value: false.

HttpServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

HttpVpcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

MockServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

Name string

System parameter name which supports values including in system parameter list.

RequestParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs>

request_parameters defines the request parameters of the api.

StageNames List<string>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

SystemParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiSystemParameterArgs>

system_parameters defines the system parameters of the api.

AuthType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

Description string

The description of Constant parameter.

GroupId string

The api gateway that the api belongs to. Defaults to null.

RequestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

ServiceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

ConstantParameters []ApiConstantParameterArgs

constant_parameters defines the constant parameters of the api.

FcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

ForceNonceCheck bool

Whether to prevent API replay attack. Default value: false.

HttpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

HttpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

MockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

Name string

System parameter name which supports values including in system parameter list.

RequestParameters []ApiRequestParameterArgs

request_parameters defines the request parameters of the api.

StageNames []string

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

SystemParameters []ApiSystemParameterArgs

system_parameters defines the system parameters of the api.

authType String

The authorization Type including APP and ANONYMOUS. Defaults to null.

description String

The description of Constant parameter.

groupId String

The api gateway that the api belongs to. Defaults to null.

requestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

serviceType String

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

constantParameters List<ApiConstantParameterArgs>

constant_parameters defines the constant parameters of the api.

fcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck Boolean

Whether to prevent API replay attack. Default value: false.

httpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name String

System parameter name which supports values including in system parameter list.

requestParameters List<ApiRequestParameterArgs>

request_parameters defines the request parameters of the api.

stageNames List<String>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters List<ApiSystemParameterArgs>

system_parameters defines the system parameters of the api.

authType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

description string

The description of Constant parameter.

groupId string

The api gateway that the api belongs to. Defaults to null.

requestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

serviceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

constantParameters ApiConstantParameterArgs[]

constant_parameters defines the constant parameters of the api.

fcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck boolean

Whether to prevent API replay attack. Default value: false.

httpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name string

System parameter name which supports values including in system parameter list.

requestParameters ApiRequestParameterArgs[]

request_parameters defines the request parameters of the api.

stageNames string[]

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters ApiSystemParameterArgs[]

system_parameters defines the system parameters of the api.

auth_type str

The authorization Type including APP and ANONYMOUS. Defaults to null.

description str

The description of Constant parameter.

group_id str

The api gateway that the api belongs to. Defaults to null.

request_config ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

service_type str

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

constant_parameters Sequence[ApiConstantParameterArgs]

constant_parameters defines the constant parameters of the api.

fc_service_config ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

force_nonce_check bool

Whether to prevent API replay attack. Default value: false.

http_service_config ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

http_vpc_service_config ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mock_service_config ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name str

System parameter name which supports values including in system parameter list.

request_parameters Sequence[ApiRequestParameterArgs]

request_parameters defines the request parameters of the api.

stage_names Sequence[str]

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

system_parameters Sequence[ApiSystemParameterArgs]

system_parameters defines the system parameters of the api.

authType String

The authorization Type including APP and ANONYMOUS. Defaults to null.

description String

The description of Constant parameter.

groupId String

The api gateway that the api belongs to. Defaults to null.

requestConfig Property Map

Request_config defines how users can send requests to your API.

serviceType String

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

constantParameters List<Property Map>

constant_parameters defines the constant parameters of the api.

fcServiceConfig Property Map

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck Boolean

Whether to prevent API replay attack. Default value: false.

httpServiceConfig Property Map

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig Property Map

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig Property Map

http_service_config defines the config when service_type selected 'MOCK'.

name String

System parameter name which supports values including in system parameter list.

requestParameters List<Property Map>

request_parameters defines the request parameters of the api.

stageNames List<String>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters List<Property Map>

system_parameters defines the system parameters of the api.

Outputs

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

ApiId string

The ID of the api of api gateway.

Id string

The provider-assigned unique ID for this managed resource.

ApiId string

The ID of the api of api gateway.

Id string

The provider-assigned unique ID for this managed resource.

apiId String

The ID of the api of api gateway.

id String

The provider-assigned unique ID for this managed resource.

apiId string

The ID of the api of api gateway.

id string

The provider-assigned unique ID for this managed resource.

api_id str

The ID of the api of api gateway.

id str

The provider-assigned unique ID for this managed resource.

apiId String

The ID of the api of api gateway.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Api Resource

Get an existing Api 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?: ApiState, opts?: CustomResourceOptions): Api
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_id: Optional[str] = None,
        auth_type: Optional[str] = None,
        constant_parameters: Optional[Sequence[ApiConstantParameterArgs]] = None,
        description: Optional[str] = None,
        fc_service_config: Optional[ApiFcServiceConfigArgs] = None,
        force_nonce_check: Optional[bool] = None,
        group_id: Optional[str] = None,
        http_service_config: Optional[ApiHttpServiceConfigArgs] = None,
        http_vpc_service_config: Optional[ApiHttpVpcServiceConfigArgs] = None,
        mock_service_config: Optional[ApiMockServiceConfigArgs] = None,
        name: Optional[str] = None,
        request_config: Optional[ApiRequestConfigArgs] = None,
        request_parameters: Optional[Sequence[ApiRequestParameterArgs]] = None,
        service_type: Optional[str] = None,
        stage_names: Optional[Sequence[str]] = None,
        system_parameters: Optional[Sequence[ApiSystemParameterArgs]] = None) -> Api
func GetApi(ctx *Context, name string, id IDInput, state *ApiState, opts ...ResourceOption) (*Api, error)
public static Api Get(string name, Input<string> id, ApiState? state, CustomResourceOptions? opts = null)
public static Api get(String name, Output<String> id, ApiState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiId string

The ID of the api of api gateway.

AuthType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

ConstantParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiConstantParameterArgs>

constant_parameters defines the constant parameters of the api.

Description string

The description of Constant parameter.

FcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

ForceNonceCheck bool

Whether to prevent API replay attack. Default value: false.

GroupId string

The api gateway that the api belongs to. Defaults to null.

HttpServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

HttpVpcServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

MockServiceConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

Name string

System parameter name which supports values including in system parameter list.

RequestConfig Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

RequestParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiRequestParameterArgs>

request_parameters defines the request parameters of the api.

ServiceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

StageNames List<string>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

SystemParameters List<Pulumi.AliCloud.ApiGateway.Inputs.ApiSystemParameterArgs>

system_parameters defines the system parameters of the api.

ApiId string

The ID of the api of api gateway.

AuthType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

ConstantParameters []ApiConstantParameterArgs

constant_parameters defines the constant parameters of the api.

Description string

The description of Constant parameter.

FcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

ForceNonceCheck bool

Whether to prevent API replay attack. Default value: false.

GroupId string

The api gateway that the api belongs to. Defaults to null.

HttpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

HttpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

MockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

Name string

System parameter name which supports values including in system parameter list.

RequestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

RequestParameters []ApiRequestParameterArgs

request_parameters defines the request parameters of the api.

ServiceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

StageNames []string

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

SystemParameters []ApiSystemParameterArgs

system_parameters defines the system parameters of the api.

apiId String

The ID of the api of api gateway.

authType String

The authorization Type including APP and ANONYMOUS. Defaults to null.

constantParameters List<ApiConstantParameterArgs>

constant_parameters defines the constant parameters of the api.

description String

The description of Constant parameter.

fcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck Boolean

Whether to prevent API replay attack. Default value: false.

groupId String

The api gateway that the api belongs to. Defaults to null.

httpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name String

System parameter name which supports values including in system parameter list.

requestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

requestParameters List<ApiRequestParameterArgs>

request_parameters defines the request parameters of the api.

serviceType String

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

stageNames List<String>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters List<ApiSystemParameterArgs>

system_parameters defines the system parameters of the api.

apiId string

The ID of the api of api gateway.

authType string

The authorization Type including APP and ANONYMOUS. Defaults to null.

constantParameters ApiConstantParameterArgs[]

constant_parameters defines the constant parameters of the api.

description string

The description of Constant parameter.

fcServiceConfig ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck boolean

Whether to prevent API replay attack. Default value: false.

groupId string

The api gateway that the api belongs to. Defaults to null.

httpServiceConfig ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name string

System parameter name which supports values including in system parameter list.

requestConfig ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

requestParameters ApiRequestParameterArgs[]

request_parameters defines the request parameters of the api.

serviceType string

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

stageNames string[]

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters ApiSystemParameterArgs[]

system_parameters defines the system parameters of the api.

api_id str

The ID of the api of api gateway.

auth_type str

The authorization Type including APP and ANONYMOUS. Defaults to null.

constant_parameters Sequence[ApiConstantParameterArgs]

constant_parameters defines the constant parameters of the api.

description str

The description of Constant parameter.

fc_service_config ApiFcServiceConfigArgs

fc_service_config defines the config when service_type selected 'FunctionCompute'.

force_nonce_check bool

Whether to prevent API replay attack. Default value: false.

group_id str

The api gateway that the api belongs to. Defaults to null.

http_service_config ApiHttpServiceConfigArgs

http_service_config defines the config when service_type selected 'HTTP'.

http_vpc_service_config ApiHttpVpcServiceConfigArgs

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mock_service_config ApiMockServiceConfigArgs

http_service_config defines the config when service_type selected 'MOCK'.

name str

System parameter name which supports values including in system parameter list.

request_config ApiRequestConfigArgs

Request_config defines how users can send requests to your API.

request_parameters Sequence[ApiRequestParameterArgs]

request_parameters defines the request parameters of the api.

service_type str

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

stage_names Sequence[str]

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

system_parameters Sequence[ApiSystemParameterArgs]

system_parameters defines the system parameters of the api.

apiId String

The ID of the api of api gateway.

authType String

The authorization Type including APP and ANONYMOUS. Defaults to null.

constantParameters List<Property Map>

constant_parameters defines the constant parameters of the api.

description String

The description of Constant parameter.

fcServiceConfig Property Map

fc_service_config defines the config when service_type selected 'FunctionCompute'.

forceNonceCheck Boolean

Whether to prevent API replay attack. Default value: false.

groupId String

The api gateway that the api belongs to. Defaults to null.

httpServiceConfig Property Map

http_service_config defines the config when service_type selected 'HTTP'.

httpVpcServiceConfig Property Map

http_vpc_service_config defines the config when service_type selected 'HTTP-VPC'.

mockServiceConfig Property Map

http_service_config defines the config when service_type selected 'MOCK'.

name String

System parameter name which supports values including in system parameter list.

requestConfig Property Map

Request_config defines how users can send requests to your API.

requestParameters List<Property Map>

request_parameters defines the request parameters of the api.

serviceType String

The type of backend service. Type including HTTP,VPC and MOCK. Defaults to null.

stageNames List<String>

Stages that the api need to be deployed. Valid value: RELEASE,PRE,TEST.

systemParameters List<Property Map>

system_parameters defines the system parameters of the api.

Supporting Types

ApiConstantParameter

In string

System parameter location; values: 'HEAD' and 'QUERY'.

Name string

System parameter name which supports values including in system parameter list.

Value string

Constant parameter value.

Description string

The description of Constant parameter.

In string

System parameter location; values: 'HEAD' and 'QUERY'.

Name string

System parameter name which supports values including in system parameter list.

Value string

Constant parameter value.

Description string

The description of Constant parameter.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

name String

System parameter name which supports values including in system parameter list.

value String

Constant parameter value.

description String

The description of Constant parameter.

in string

System parameter location; values: 'HEAD' and 'QUERY'.

name string

System parameter name which supports values including in system parameter list.

value string

Constant parameter value.

description string

The description of Constant parameter.

in_ str

System parameter location; values: 'HEAD' and 'QUERY'.

name str

System parameter name which supports values including in system parameter list.

value str

Constant parameter value.

description str

The description of Constant parameter.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

name String

System parameter name which supports values including in system parameter list.

value String

Constant parameter value.

description String

The description of Constant parameter.

ApiFcServiceConfig

FunctionName string

The function name of function compute service.

Region string

The region that the function compute service belongs to.

ServiceName string

The service name of function compute service.

Timeout int

Backend service time-out time; unit: millisecond.

ArnRole string

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

FunctionName string

The function name of function compute service.

Region string

The region that the function compute service belongs to.

ServiceName string

The service name of function compute service.

Timeout int

Backend service time-out time; unit: millisecond.

ArnRole string

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

functionName String

The function name of function compute service.

region String

The region that the function compute service belongs to.

serviceName String

The service name of function compute service.

timeout Integer

Backend service time-out time; unit: millisecond.

arnRole String

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

functionName string

The function name of function compute service.

region string

The region that the function compute service belongs to.

serviceName string

The service name of function compute service.

timeout number

Backend service time-out time; unit: millisecond.

arnRole string

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

function_name str

The function name of function compute service.

region str

The region that the function compute service belongs to.

service_name str

The service name of function compute service.

timeout int

Backend service time-out time; unit: millisecond.

arn_role str

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

functionName String

The function name of function compute service.

region String

The region that the function compute service belongs to.

serviceName String

The service name of function compute service.

timeout Number

Backend service time-out time; unit: millisecond.

arnRole String

RAM role arn attached to the Function Compute service. This governs both who / what can invoke your Function, as well as what resources our Function has access to. See User Permissions for more details.

ApiHttpServiceConfig

Address string

The address of backend service.

Method string

The http method of backend service.

Path string

The path of backend service.

Timeout int

Backend service time-out time; unit: millisecond.

AoneName string
Address string

The address of backend service.

Method string

The http method of backend service.

Path string

The path of backend service.

Timeout int

Backend service time-out time; unit: millisecond.

AoneName string
address String

The address of backend service.

method String

The http method of backend service.

path String

The path of backend service.

timeout Integer

Backend service time-out time; unit: millisecond.

aoneName String
address string

The address of backend service.

method string

The http method of backend service.

path string

The path of backend service.

timeout number

Backend service time-out time; unit: millisecond.

aoneName string
address str

The address of backend service.

method str

The http method of backend service.

path str

The path of backend service.

timeout int

Backend service time-out time; unit: millisecond.

aone_name str
address String

The address of backend service.

method String

The http method of backend service.

path String

The path of backend service.

timeout Number

Backend service time-out time; unit: millisecond.

aoneName String

ApiHttpVpcServiceConfig

Method string

The http method of backend service.

Name string

System parameter name which supports values including in system parameter list.

Path string

The path of backend service.

Timeout int

Backend service time-out time; unit: millisecond.

AoneName string
Method string

The http method of backend service.

Name string

System parameter name which supports values including in system parameter list.

Path string

The path of backend service.

Timeout int

Backend service time-out time; unit: millisecond.

AoneName string
method String

The http method of backend service.

name String

System parameter name which supports values including in system parameter list.

path String

The path of backend service.

timeout Integer

Backend service time-out time; unit: millisecond.

aoneName String
method string

The http method of backend service.

name string

System parameter name which supports values including in system parameter list.

path string

The path of backend service.

timeout number

Backend service time-out time; unit: millisecond.

aoneName string
method str

The http method of backend service.

name str

System parameter name which supports values including in system parameter list.

path str

The path of backend service.

timeout int

Backend service time-out time; unit: millisecond.

aone_name str
method String

The http method of backend service.

name String

System parameter name which supports values including in system parameter list.

path String

The path of backend service.

timeout Number

Backend service time-out time; unit: millisecond.

aoneName String

ApiMockServiceConfig

Result string

The result of the mock service.

AoneName string
Result string

The result of the mock service.

AoneName string
result String

The result of the mock service.

aoneName String
result string

The result of the mock service.

aoneName string
result str

The result of the mock service.

aone_name str
result String

The result of the mock service.

aoneName String

ApiRequestConfig

Method string

The http method of backend service.

Mode string

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

Path string

The path of backend service.

Protocol string

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

BodyFormat string

The body format of the api, which support the values of 'STREAM' and 'FORM'.

Method string

The http method of backend service.

Mode string

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

Path string

The path of backend service.

Protocol string

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

BodyFormat string

The body format of the api, which support the values of 'STREAM' and 'FORM'.

method String

The http method of backend service.

mode String

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

path String

The path of backend service.

protocol String

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

bodyFormat String

The body format of the api, which support the values of 'STREAM' and 'FORM'.

method string

The http method of backend service.

mode string

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

path string

The path of backend service.

protocol string

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

bodyFormat string

The body format of the api, which support the values of 'STREAM' and 'FORM'.

method str

The http method of backend service.

mode str

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

path str

The path of backend service.

protocol str

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

body_format str

The body format of the api, which support the values of 'STREAM' and 'FORM'.

method String

The http method of backend service.

mode String

The mode of the parameters between request parameters and service parameters, which support the values of 'MAPPING' and 'PASSTHROUGH'.

path String

The path of backend service.

protocol String

The protocol of api which supports values of 'HTTP','HTTPS' or 'HTTP,HTTPS'.

bodyFormat String

The body format of the api, which support the values of 'STREAM' and 'FORM'.

ApiRequestParameter

In string

System parameter location; values: 'HEAD' and 'QUERY'.

InService string

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

Name string

System parameter name which supports values including in system parameter list.

NameService string

Backend service's parameter name.

Required string

Parameter required or not; values: REQUIRED and OPTIONAL.

Type string

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

DefaultValue string

The default value of the parameter.

Description string

The description of Constant parameter.

In string

System parameter location; values: 'HEAD' and 'QUERY'.

InService string

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

Name string

System parameter name which supports values including in system parameter list.

NameService string

Backend service's parameter name.

Required string

Parameter required or not; values: REQUIRED and OPTIONAL.

Type string

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

DefaultValue string

The default value of the parameter.

Description string

The description of Constant parameter.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

inService String

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

name String

System parameter name which supports values including in system parameter list.

nameService String

Backend service's parameter name.

required String

Parameter required or not; values: REQUIRED and OPTIONAL.

type String

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

defaultValue String

The default value of the parameter.

description String

The description of Constant parameter.

in string

System parameter location; values: 'HEAD' and 'QUERY'.

inService string

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

name string

System parameter name which supports values including in system parameter list.

nameService string

Backend service's parameter name.

required string

Parameter required or not; values: REQUIRED and OPTIONAL.

type string

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

defaultValue string

The default value of the parameter.

description string

The description of Constant parameter.

in_ str

System parameter location; values: 'HEAD' and 'QUERY'.

in_service str

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

name str

System parameter name which supports values including in system parameter list.

name_service str

Backend service's parameter name.

required str

Parameter required or not; values: REQUIRED and OPTIONAL.

type str

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

default_value str

The default value of the parameter.

description str

The description of Constant parameter.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

inService String

Backend service's parameter location; values: BODY, HEAD, QUERY, and PATH.

name String

System parameter name which supports values including in system parameter list.

nameService String

Backend service's parameter name.

required String

Parameter required or not; values: REQUIRED and OPTIONAL.

type String

Parameter type which supports values of 'STRING','INT','BOOLEAN','LONG',"FLOAT" and "DOUBLE".

defaultValue String

The default value of the parameter.

description String

The description of Constant parameter.

ApiSystemParameter

In string

System parameter location; values: 'HEAD' and 'QUERY'.

Name string

System parameter name which supports values including in system parameter list.

NameService string

Backend service's parameter name.

In string

System parameter location; values: 'HEAD' and 'QUERY'.

Name string

System parameter name which supports values including in system parameter list.

NameService string

Backend service's parameter name.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

name String

System parameter name which supports values including in system parameter list.

nameService String

Backend service's parameter name.

in string

System parameter location; values: 'HEAD' and 'QUERY'.

name string

System parameter name which supports values including in system parameter list.

nameService string

Backend service's parameter name.

in_ str

System parameter location; values: 'HEAD' and 'QUERY'.

name str

System parameter name which supports values including in system parameter list.

name_service str

Backend service's parameter name.

in String

System parameter location; values: 'HEAD' and 'QUERY'.

name String

System parameter name which supports values including in system parameter list.

nameService String

Backend service's parameter name.

Package Details

Repository
https://github.com/pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.