HttpApiArgs

data class HttpApiArgs(val basePath: Output<String>? = null, val description: Output<String>? = null, val httpApiName: Output<String>? = null, val protocols: Output<List<String>>? = null, val resourceGroupId: Output<String>? = null, val type: Output<String>? = null) : ConvertibleToJava<HttpApiArgs>

Provides a APIG Http Api resource. For information about APIG Http Api and how to use it, see What is Http Api.

NOTE: Available since v1.240.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const protocol = config.get("protocol") || "HTTP";
const protocolHttps = config.get("protocolHttps") || "HTTPS";
const _default = alicloud.resourcemanager.getResourceGroups({});
const defaultHttpApi = new alicloud.apig.HttpApi("default", {
httpApiName: name,
protocols: [protocol],
basePath: "/v1",
description: "zhiwei_pop_examplecase",
type: "Rest",
});
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "terraform-example"
protocol = config.get("protocol")
if protocol is None:
protocol = "HTTP"
protocol_https = config.get("protocolHttps")
if protocol_https is None:
protocol_https = "HTTPS"
default = alicloud.resourcemanager.get_resource_groups()
default_http_api = alicloud.apig.HttpApi("default",
http_api_name=name,
protocols=[protocol],
base_path="/v1",
description="zhiwei_pop_examplecase",
type="Rest")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "terraform-example";
var protocol = config.Get("protocol") ?? "HTTP";
var protocolHttps = config.Get("protocolHttps") ?? "HTTPS";
var @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();
var defaultHttpApi = new AliCloud.Apig.HttpApi("default", new()
{
HttpApiName = name,
Protocols = new[]
{
protocol,
},
BasePath = "/v1",
Description = "zhiwei_pop_examplecase",
Type = "Rest",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apig"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
name := "terraform-example"
if param := cfg.Get("name"); param != "" {
name = param
}
protocol := "HTTP"
if param := cfg.Get("protocol"); param != "" {
protocol = param
}
protocolHttps := "HTTPS"
if param := cfg.Get("protocolHttps"); param != "" {
protocolHttps = param
}
_, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
if err != nil {
return err
}
_, err = apig.NewHttpApi(ctx, "default", &apig.HttpApiArgs{
HttpApiName: pulumi.String(name),
Protocols: pulumi.StringArray{
pulumi.String(protocol),
},
BasePath: pulumi.String("/v1"),
Description: pulumi.String("zhiwei_pop_examplecase"),
Type: pulumi.String("Rest"),
})
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.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.alicloud.apig.HttpApi;
import com.pulumi.alicloud.apig.HttpApiArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var name = config.get("name").orElse("terraform-example");
final var protocol = config.get("protocol").orElse("HTTP");
final var protocolHttps = config.get("protocolHttps").orElse("HTTPS");
final var default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
.build());
var defaultHttpApi = new HttpApi("defaultHttpApi", HttpApiArgs.builder()
.httpApiName(name)
.protocols(protocol)
.basePath("/v1")
.description("zhiwei_pop_examplecase")
.type("Rest")
.build());
}
}
configuration:
name:
type: string
default: terraform-example
protocol:
type: string
default: HTTP
protocolHttps:
type: string
default: HTTPS
resources:
defaultHttpApi:
type: alicloud:apig:HttpApi
name: default
properties:
httpApiName: ${name}
protocols:
- ${protocol}
basePath: /v1
description: zhiwei_pop_examplecase
type: Rest
variables:
default:
fn::invoke:
function: alicloud:resourcemanager:getResourceGroups
arguments: {}

Import

APIG Http Api can be imported using the id, e.g.

$ pulumi import alicloud:apig/httpApi:HttpApi example <id>

Constructors

Link copied to clipboard
constructor(basePath: Output<String>? = null, description: Output<String>? = null, httpApiName: Output<String>? = null, protocols: Output<List<String>>? = null, resourceGroupId: Output<String>? = null, type: Output<String>? = null)

Properties

Link copied to clipboard
val basePath: Output<String>? = null

API path

Link copied to clipboard
val description: Output<String>? = null

Description of API

Link copied to clipboard
val httpApiName: Output<String>? = null

The name of the resource

Link copied to clipboard
val protocols: Output<List<String>>? = null

API protocol

Link copied to clipboard
val resourceGroupId: Output<String>? = null

The ID of the resource group

Link copied to clipboard
val type: Output<String>? = null

API type

Functions

Link copied to clipboard
open override fun toJava(): HttpApiArgs