Api
data class ApiArgs(val authType: Output<String>? = null, val constantParameters: Output<List<ApiConstantParameterArgs>>? = null, val description: Output<String>? = null, val fcServiceConfig: Output<ApiFcServiceConfigArgs>? = null, val forceNonceCheck: Output<Boolean>? = null, val groupId: Output<String>? = null, val httpServiceConfig: Output<ApiHttpServiceConfigArgs>? = null, val httpVpcServiceConfig: Output<ApiHttpVpcServiceConfigArgs>? = null, val mockServiceConfig: Output<ApiMockServiceConfigArgs>? = null, val name: Output<String>? = null, val requestConfig: Output<ApiRequestConfigArgs>? = null, val requestParameters: Output<List<ApiRequestParameterArgs>>? = null, val serviceType: Output<String>? = null, val stageNames: Output<List<String>>? = null, val systemParameters: Output<List<ApiSystemParameterArgs>>? = null) : ConvertibleToJava<ApiArgs>
Example Usage
Basic Usage
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 exampleGroup = new Group("exampleGroup", GroupArgs.builder()
.description("tf-example")
.build());
var exampleApi = new Api("exampleApi", ApiArgs.builder()
.groupId(exampleGroup.id())
.description("tf-example")
.authType("APP")
.forceNonceCheck(false)
.requestConfig(ApiRequestConfigArgs.builder()
.protocol("HTTP")
.method("GET")
.path("/example/path")
.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("example")
.type("STRING")
.required("OPTIONAL")
.in("QUERY")
.inService("QUERY")
.nameService("exampleservice")
.build())
.stageNames(
"RELEASE",
"TEST")
.build());
}
}Content copied to clipboard
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"Content copied to clipboard
Constructors
Link copied to clipboard
fun ApiArgs(authType: Output<String>? = null, constantParameters: Output<List<ApiConstantParameterArgs>>? = null, description: Output<String>? = null, fcServiceConfig: Output<ApiFcServiceConfigArgs>? = null, forceNonceCheck: Output<Boolean>? = null, groupId: Output<String>? = null, httpServiceConfig: Output<ApiHttpServiceConfigArgs>? = null, httpVpcServiceConfig: Output<ApiHttpVpcServiceConfigArgs>? = null, mockServiceConfig: Output<ApiMockServiceConfigArgs>? = null, name: Output<String>? = null, requestConfig: Output<ApiRequestConfigArgs>? = null, requestParameters: Output<List<ApiRequestParameterArgs>>? = null, serviceType: Output<String>? = null, stageNames: Output<List<String>>? = null, systemParameters: Output<List<ApiSystemParameterArgs>>? = null)