Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Alibaba Cloud Provider
  4. API Docs
  5. apig
  6. Gateway
Viewing docs for Alibaba Cloud v3.109.1
published on Tuesday, Oct 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.apig.Gateway

alicloud logo alicloud logo
Viewing docs for Alibaba Cloud v3.109.1
published on Tuesday, Oct 13, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides a APIG Gateway resource.

    Gateway instance .

    For information about APIG Gateway and how to use it, see What is Gateway.

    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 _default = alicloud.resourcemanager.getResourceGroups({});
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = defaultGetNetworks.then(defaultGetNetworks => alicloud.vpc.getSwitches({
    vpcId: defaultGetNetworks.ids?.[0],
}));
const defaultGateway = new alicloud.apig.Gateway("default", {
    networkAccessConfig: {
        type: "Intranet",
    },
    logConfig: {
        sls: {
            enable: false,
        },
    },
    resourceGroupId: _default.then(_default => _default.ids?.[1]),
    spec: "apigw.small.x1",
    vpc: {
        vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
    },
    zoneConfig: {
        selectOption: "Auto",
    },
    vswitch: {
        vswitchId: defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]),
    },
    paymentType: "PayAsYouGo",
    gatewayName: name,
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.resourcemanager.get_resource_groups()
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$")
default_get_switches = alicloud.vpc.get_switches(vpc_id=default_get_networks.ids[0])
default_gateway = alicloud.apig.Gateway("default",
    network_access_config={
        "type": "Intranet",
    },
    log_config={
        "sls": {
            "enable": False,
        },
    },
    resource_group_id=default.ids[1],
    spec="apigw.small.x1",
    vpc={
        "vpc_id": default_get_networks.ids[0],
    },
    zone_config={
        "select_option": "Auto",
    },
    vswitch={
        "vswitch_id": default_get_switches.ids[0],
    },
    payment_type="PayAsYouGo",
    gateway_name=name)

    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-alicloud/sdk/v3/go/alicloud/vpc"
	"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
		}
		_default, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("^default-NODELETING$"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			VpcId: pulumi.StringRef(defaultGetNetworks.Ids[0]),
		}, nil)
		if err != nil {
			return err
		}
		_, err = apig.NewGateway(ctx, "default", &apig.GatewayArgs{
			NetworkAccessConfig: &apig.GatewayNetworkAccessConfigArgs{
				Type: pulumi.String("Intranet"),
			},
			LogConfig: &apig.GatewayLogConfigArgs{
				Sls: &apig.GatewayLogConfigSlsArgs{
					Enable: pulumi.Bool(false),
				},
			},
			ResourceGroupId: pulumi.String(_default.Ids[1]),
			Spec:            pulumi.String("apigw.small.x1"),
			Vpc: &apig.GatewayVpcArgs{
				VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
			},
			ZoneConfig: &apig.GatewayZoneConfigArgs{
				SelectOption: pulumi.String("Auto"),
			},
			Vswitch: &apig.GatewayVswitchArgs{
				VswitchId: pulumi.String(defaultGetSwitches.Ids[0]),
			},
			PaymentType: pulumi.String("PayAsYouGo"),
			GatewayName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 @default = AliCloud.ResourceManager.GetResourceGroups.Invoke();

    var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "^default-NODELETING$",
    });

    var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
    });

    var defaultGateway = new AliCloud.Apig.Gateway("default", new()
    {
        NetworkAccessConfig = new AliCloud.Apig.Inputs.GatewayNetworkAccessConfigArgs
        {
            Type = "Intranet",
        },
        LogConfig = new AliCloud.Apig.Inputs.GatewayLogConfigArgs
        {
            Sls = new AliCloud.Apig.Inputs.GatewayLogConfigSlsArgs
            {
                Enable = false,
            },
        },
        ResourceGroupId = @default.Apply(@default => @default.Apply(getResourceGroupsResult => getResourceGroupsResult.Ids[1])),
        Spec = "apigw.small.x1",
        Vpc = new AliCloud.Apig.Inputs.GatewayVpcArgs
        {
            VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        },
        ZoneConfig = new AliCloud.Apig.Inputs.GatewayZoneConfigArgs
        {
            SelectOption = "Auto",
        },
        Vswitch = new AliCloud.Apig.Inputs.GatewayVswitchArgs
        {
            VswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]),
        },
        PaymentType = "PayAsYouGo",
        GatewayName = name,
    });

});

    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.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.apig.Gateway;
import com.pulumi.alicloud.apig.GatewayArgs;
import com.pulumi.alicloud.apig.inputs.GatewayNetworkAccessConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayLogConfigSlsArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVpcArgs;
import com.pulumi.alicloud.apig.inputs.GatewayZoneConfigArgs;
import com.pulumi.alicloud.apig.inputs.GatewayVswitchArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 default = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .build());

        final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("^default-NODELETING$")
            .build());

        final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .vpcId(defaultGetNetworks.ids()[0])
            .build());

        var defaultGateway = new Gateway("defaultGateway", GatewayArgs.builder()
            .networkAccessConfig(GatewayNetworkAccessConfigArgs.builder()
                .type("Intranet")
                .build())
            .logConfig(GatewayLogConfigArgs.builder()
                .sls(GatewayLogConfigSlsArgs.builder()
                    .enable(false)
                    .build())
                .build())
            .resourceGroupId(default_.ids()[1])
            .spec("apigw.small.x1")
            .vpc(GatewayVpcArgs.builder()
                .vpcId(defaultGetNetworks.ids()[0])
                .build())
            .zoneConfig(GatewayZoneConfigArgs.builder()
                .selectOption("Auto")
                .build())
            .vswitch(GatewayVswitchArgs.builder()
                .vswitchId(defaultGetSwitches.ids()[0])
                .build())
            .paymentType("PayAsYouGo")
            .gatewayName(name)
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  defaultGateway:
    type: alicloud:apig:Gateway
    name: default
    properties:
      networkAccessConfig:
        type: Intranet
      logConfig:
        sls:
          enable: 'false'
      resourceGroupId: ${default.ids[1]}
      spec: apigw.small.x1
      vpc:
        vpcId: ${defaultGetNetworks.ids[0]}
      zoneConfig:
        selectOption: Auto
      vswitch:
        vswitchId: ${defaultGetSwitches.ids[0]}
      paymentType: PayAsYouGo
      gatewayName: ${name}
variables:
  default:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments: {}
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        vpcId: ${defaultGetNetworks.ids[0]}

    terraform {
  required_providers {
    alicloud = {
      source = "pulumi/alicloud"
    }
  }
}

data "alicloud_resourcemanager_resource_groups" "default" {
}
data "alicloud_vpc_networks" "defaultGetNetworks" {
  name_regex = "^default-NODELETING$"
}
data "alicloud_vpc_switches" "defaultGetSwitches" {
  vpc_id = data.alicloud_vpc_networks.defaultGetNetworks.ids[0]
}

resource "alicloud_apig_gateway" "default" {
  lifecycle {
    create_before_destroy = true
  }
  network_access_config = {
    type = "Intranet"
  }
  log_config = {
    sls = {
      enable = "false"
    }
  }
  resource_group_id = data.alicloud_resourcemanager_resource_groups.default.ids[1]
  spec              = "apigw.small.x1"
  vpc = {
    vpc_id = data.alicloud_vpc_networks.defaultGetNetworks.ids[0]
  }
  zone_config = {
    select_option = "Auto"
  }
  vswitch = {
    vswitch_id = data.alicloud_vpc_switches.defaultGetSwitches.ids[0]
  }
  payment_type = "PayAsYouGo"
  gateway_name = var.name
}
variable "name" {
  type    = string
  default = "terraform-example"
}

    Deleting alicloud.apig.Gateway or removing it from your configuration

    The alicloud.apig.Gateway resource allows you to manage paymentType = "Subscription" instance, but Terraform cannot destroy it. Deleting the subscription resource or removing it from your configuration will remove it from your state file and management, but will not destroy the Instance. You can resume managing the subscription instance via the AlibabaCloud Console.

    📚 Need more examples? VIEW MORE EXAMPLES

    Create Gateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Gateway(name: string, args: GatewayArgs, opts?: CustomResourceOptions);
    @overload
def Gateway(resource_name: str,
            args: GatewayArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Gateway(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            payment_type: Optional[str] = None,
            zone_config: Optional[GatewayZoneConfigArgs] = None,
            resource_group_id: Optional[str] = None,
            log_config: Optional[GatewayLogConfigArgs] = None,
            network_access_config: Optional[GatewayNetworkAccessConfigArgs] = None,
            gateway_type: Optional[str] = None,
            gateway_edition: Optional[str] = None,
            spec: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            vpc: Optional[GatewayVpcArgs] = None,
            vswitch: Optional[GatewayVswitchArgs] = None,
            gateway_name: Optional[str] = None,
            zones: Optional[Sequence[GatewayZoneArgs]] = None)
    func NewGateway(ctx *Context, name string, args GatewayArgs, opts ...ResourceOption) (*Gateway, error)
    public Gateway(string name, GatewayArgs args, CustomResourceOptions? opts = null)
    public Gateway(String name, GatewayArgs args)
public Gateway(String name, GatewayArgs args, CustomResourceOptions options)

    type: alicloud:apig:Gateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "alicloud_apig_gateway" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GatewayArgs
    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 GatewayArgs
    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 GatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayArgs
    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 gatewayResource = new AliCloud.Apig.Gateway("gatewayResource", new()
{
    PaymentType = "string",
    ZoneConfig = new AliCloud.Apig.Inputs.GatewayZoneConfigArgs
    {
        SelectOption = "string",
    },
    ResourceGroupId = "string",
    LogConfig = new AliCloud.Apig.Inputs.GatewayLogConfigArgs
    {
        Sls = new AliCloud.Apig.Inputs.GatewayLogConfigSlsArgs
        {
            Enable = false,
        },
    },
    NetworkAccessConfig = new AliCloud.Apig.Inputs.GatewayNetworkAccessConfigArgs
    {
        Type = "string",
    },
    GatewayType = "string",
    GatewayEdition = "string",
    Spec = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Vpc = new AliCloud.Apig.Inputs.GatewayVpcArgs
    {
        VpcId = "string",
        Name = "string",
    },
    Vswitch = new AliCloud.Apig.Inputs.GatewayVswitchArgs
    {
        Name = "string",
        VswitchId = "string",
    },
    GatewayName = "string",
    Zones = new[]
    {
        new AliCloud.Apig.Inputs.GatewayZoneArgs
        {
            Name = "string",
            VswitchId = "string",
            ZoneId = "string",
        },
    },
});

    example, err := apig.NewGateway(ctx, "gatewayResource", &apig.GatewayArgs{
	PaymentType: pulumi.String("string"),
	ZoneConfig: &apig.GatewayZoneConfigArgs{
		SelectOption: pulumi.String("string"),
	},
	ResourceGroupId: pulumi.String("string"),
	LogConfig: &apig.GatewayLogConfigArgs{
		Sls: &apig.GatewayLogConfigSlsArgs{
			Enable: pulumi.Bool(false),
		},
	},
	NetworkAccessConfig: &apig.GatewayNetworkAccessConfigArgs{
		Type: pulumi.String("string"),
	},
	GatewayType:    pulumi.String("string"),
	GatewayEdition: pulumi.String("string"),
	Spec:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Vpc: &apig.GatewayVpcArgs{
		VpcId: pulumi.String("string"),
		Name:  pulumi.String("string"),
	},
	Vswitch: &apig.GatewayVswitchArgs{
		Name:      pulumi.String("string"),
		VswitchId: pulumi.String("string"),
	},
	GatewayName: pulumi.String("string"),
	Zones: apig.GatewayZoneArray{
		&apig.GatewayZoneArgs{
			Name:      pulumi.String("string"),
			VswitchId: pulumi.String("string"),
			ZoneId:    pulumi.String("string"),
		},
	},
})

    resource "alicloud_apig_gateway" "gatewayResource" {
  lifecycle {
    create_before_destroy = true
  }
  payment_type = "string"
  zone_config = {
    select_option = "string"
  }
  resource_group_id = "string"
  log_config = {
    sls = {
      enable = false
    }
  }
  network_access_config = {
    type = "string"
  }
  gateway_type    = "string"
  gateway_edition = "string"
  spec            = "string"
  tags = {
    "string" = "string"
  }
  vpc = {
    vpc_id = "string"
    name   = "string"
  }
  vswitch = {
    name       = "string"
    vswitch_id = "string"
  }
  gateway_name = "string"
  zones {
    name       = "string"
    vswitch_id = "string"
    zone_id    = "string"
  }
}

    var gatewayResource = new com.pulumi.alicloud.apig.Gateway("gatewayResource", com.pulumi.alicloud.apig.GatewayArgs.builder()
    .paymentType("string")
    .zoneConfig(GatewayZoneConfigArgs.builder()
        .selectOption("string")
        .build())
    .resourceGroupId("string")
    .logConfig(GatewayLogConfigArgs.builder()
        .sls(GatewayLogConfigSlsArgs.builder()
            .enable(false)
            .build())
        .build())
    .networkAccessConfig(GatewayNetworkAccessConfigArgs.builder()
        .type("string")
        .build())
    .gatewayType("string")
    .gatewayEdition("string")
    .spec("string")
    .tags(Map.of("string", "string"))
    .vpc(GatewayVpcArgs.builder()
        .vpcId("string")
        .name("string")
        .build())
    .vswitch(GatewayVswitchArgs.builder()
        .name("string")
        .vswitchId("string")
        .build())
    .gatewayName("string")
    .zones(GatewayZoneArgs.builder()
        .name("string")
        .vswitchId("string")
        .zoneId("string")
        .build())
    .build());

    gateway_resource = alicloud.apig.Gateway("gatewayResource",
    payment_type="string",
    zone_config={
        "select_option": "string",
    },
    resource_group_id="string",
    log_config={
        "sls": {
            "enable": False,
        },
    },
    network_access_config={
        "type": "string",
    },
    gateway_type="string",
    gateway_edition="string",
    spec="string",
    tags={
        "string": "string",
    },
    vpc={
        "vpc_id": "string",
        "name": "string",
    },
    vswitch={
        "name": "string",
        "vswitch_id": "string",
    },
    gateway_name="string",
    zones=[{
        "name": "string",
        "vswitch_id": "string",
        "zone_id": "string",
    }])

    const gatewayResource = new alicloud.apig.Gateway("gatewayResource", {
    paymentType: "string",
    zoneConfig: {
        selectOption: "string",
    },
    resourceGroupId: "string",
    logConfig: {
        sls: {
            enable: false,
        },
    },
    networkAccessConfig: {
        type: "string",
    },
    gatewayType: "string",
    gatewayEdition: "string",
    spec: "string",
    tags: {
        string: "string",
    },
    vpc: {
        vpcId: "string",
        name: "string",
    },
    vswitch: {
        name: "string",
        vswitchId: "string",
    },
    gatewayName: "string",
    zones: [{
        name: "string",
        vswitchId: "string",
        zoneId: "string",
    }],
});

    type: alicloud:apig:Gateway
properties:
    gatewayEdition: string
    gatewayName: string
    gatewayType: string
    logConfig:
        sls:
            enable: false
    networkAccessConfig:
        type: string
    paymentType: string
    resourceGroupId: string
    spec: string
    tags:
        string: string
    vpc:
        name: string
        vpcId: string
    vswitch:
        name: string
        vswitchId: string
    zoneConfig:
        selectOption: string
    zones:
        - name: string
          vswitchId: string
          zoneId: string

    Gateway 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 Gateway resource accepts the following input properties:

    PaymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    ZoneConfig Pulumi.AliCloud.Apig.Inputs.GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    GatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    GatewayName string
    Query by exact match of the gateway name.
    GatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    LogConfig Pulumi.AliCloud.Apig.Inputs.GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    NetworkAccessConfig Pulumi.AliCloud.Apig.Inputs.GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    ResourceGroupId string
    The ID of the destination resource group.
    Spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    Tags Dictionary<string, string>
    The tag of the resource
    Vpc Pulumi.AliCloud.Apig.Inputs.GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    Vswitch Pulumi.AliCloud.Apig.Inputs.GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    Zones List<Pulumi.AliCloud.Apig.Inputs.GatewayZone>
    The list of zones associated with the gateway. See zones below.
    PaymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    ZoneConfig GatewayZoneConfigArgs
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    GatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    GatewayName string
    Query by exact match of the gateway name.
    GatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    LogConfig GatewayLogConfigArgs
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    NetworkAccessConfig GatewayNetworkAccessConfigArgs
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    ResourceGroupId string
    The ID of the destination resource group.
    Spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    Tags map[string]string
    The tag of the resource
    Vpc GatewayVpcArgs
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    Vswitch GatewayVswitchArgs
    The vSwitch associated with the gateway. See vswitch below.
    Zones []GatewayZoneArgs
    The list of zones associated with the gateway. See zones below.
    payment_type string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    zone_config object
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    gateway_edition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gateway_name string
    Query by exact match of the gateway name.
    gateway_type string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    log_config object
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    network_access_config object
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    resource_group_id string
    The ID of the destination resource group.
    spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    tags map(string)
    The tag of the resource
    vpc object
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch object
    The vSwitch associated with the gateway. See vswitch below.
    zones list(object)
    The list of zones associated with the gateway. See zones below.
    paymentType String
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    zoneConfig GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    gatewayEdition String
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName String
    Query by exact match of the gateway name.
    gatewayType String
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    logConfig GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    resourceGroupId String
    The ID of the destination resource group.
    spec String
    Gateway specification:

    • apigw.small.x1: Small specification.
    tags Map<String,String>
    The tag of the resource
    vpc GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    zones List<GatewayZone>
    The list of zones associated with the gateway. See zones below.
    paymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    zoneConfig GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    gatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName string
    Query by exact match of the gateway name.
    gatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    logConfig GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    resourceGroupId string
    The ID of the destination resource group.
    spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    tags {[key: string]: string}
    The tag of the resource
    vpc GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    zones GatewayZone[]
    The list of zones associated with the gateway. See zones below.
    payment_type str
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    zone_config GatewayZoneConfigArgs
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    gateway_edition str
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gateway_name str
    Query by exact match of the gateway name.
    gateway_type str
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    log_config GatewayLogConfigArgs
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    network_access_config GatewayNetworkAccessConfigArgs
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    resource_group_id str
    The ID of the destination resource group.
    spec str
    Gateway specification:

    • apigw.small.x1: Small specification.
    tags Mapping[str, str]
    The tag of the resource
    vpc GatewayVpcArgs
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitchArgs
    The vSwitch associated with the gateway. See vswitch below.
    zones Sequence[GatewayZoneArgs]
    The list of zones associated with the gateway. See zones below.
    paymentType String
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    zoneConfig Property Map
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    gatewayEdition String
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName String
    Query by exact match of the gateway name.
    gatewayType String
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    logConfig Property Map
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig Property Map
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    resourceGroupId String
    The ID of the destination resource group.
    spec String
    Gateway specification:

    • apigw.small.x1: Small specification.
    tags Map<String>
    The tag of the resource
    vpc Property Map
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch Property Map
    The vSwitch associated with the gateway. See vswitch below.
    zones List<Property Map>
    The list of zones associated with the gateway. See zones below.

    Outputs

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

    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Environments List<Pulumi.AliCloud.Apig.Outputs.GatewayEnvironment>
    The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancers List<Pulumi.AliCloud.Apig.Outputs.GatewayLoadBalancer>
    The list of Gateway ingress addresses.
    SecurityGroups List<Pulumi.AliCloud.Apig.Outputs.GatewaySecurityGroup>
    The security group of the gateway.
    Status string
    The status of the gateway.
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    Version string
    The current running version of the gateway instance.
    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Environments []GatewayEnvironment
    The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    Id string
    The provider-assigned unique ID for this managed resource.
    LoadBalancers []GatewayLoadBalancer
    The list of Gateway ingress addresses.
    SecurityGroups []GatewaySecurityGroup
    The security group of the gateway.
    Status string
    The status of the gateway.
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    Version string
    The current running version of the gateway instance.
    create_from string
    The source from which the gateway was created.
    create_time number
    The creation timestamp. Unit: milliseconds.
    environments list(object)
    The list of environments associated with the gateway.
    expire_time number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    id string
    The provider-assigned unique ID for this managed resource.
    load_balancers list(object)
    The list of Gateway ingress addresses.
    security_groups list(object)
    The security group of the gateway.
    status string
    The status of the gateway.
    target_version string
    The target version of the gateway instance.
    update_time number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version string
    The current running version of the gateway instance.
    createFrom String
    The source from which the gateway was created.
    createTime Integer
    The creation timestamp. Unit: milliseconds.
    environments List<GatewayEnvironment>
    The list of environments associated with the gateway.
    expireTime Integer
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancers List<GatewayLoadBalancer>
    The list of Gateway ingress addresses.
    securityGroups List<GatewaySecurityGroup>
    The security group of the gateway.
    status String
    The status of the gateway.
    targetVersion String
    The target version of the gateway instance.
    updateTime Integer
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version String
    The current running version of the gateway instance.
    createFrom string
    The source from which the gateway was created.
    createTime number
    The creation timestamp. Unit: milliseconds.
    environments GatewayEnvironment[]
    The list of environments associated with the gateway.
    expireTime number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    id string
    The provider-assigned unique ID for this managed resource.
    loadBalancers GatewayLoadBalancer[]
    The list of Gateway ingress addresses.
    securityGroups GatewaySecurityGroup[]
    The security group of the gateway.
    status string
    The status of the gateway.
    targetVersion string
    The target version of the gateway instance.
    updateTime number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version string
    The current running version of the gateway instance.
    create_from str
    The source from which the gateway was created.
    create_time int
    The creation timestamp. Unit: milliseconds.
    environments Sequence[GatewayEnvironment]
    The list of environments associated with the gateway.
    expire_time int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    id str
    The provider-assigned unique ID for this managed resource.
    load_balancers Sequence[GatewayLoadBalancer]
    The list of Gateway ingress addresses.
    security_groups Sequence[GatewaySecurityGroup]
    The security group of the gateway.
    status str
    The status of the gateway.
    target_version str
    The target version of the gateway instance.
    update_time int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version str
    The current running version of the gateway instance.
    createFrom String
    The source from which the gateway was created.
    createTime Number
    The creation timestamp. Unit: milliseconds.
    environments List<Property Map>
    The list of environments associated with the gateway.
    expireTime Number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    id String
    The provider-assigned unique ID for this managed resource.
    loadBalancers List<Property Map>
    The list of Gateway ingress addresses.
    securityGroups List<Property Map>
    The security group of the gateway.
    status String
    The status of the gateway.
    targetVersion String
    The target version of the gateway instance.
    updateTime Number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version String
    The current running version of the gateway instance.

    Look up Existing Gateway Resource

    Get an existing Gateway 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?: GatewayState, opts?: CustomResourceOptions): Gateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_from: Optional[str] = None,
        create_time: Optional[int] = None,
        environments: Optional[Sequence[GatewayEnvironmentArgs]] = None,
        expire_time: Optional[int] = None,
        gateway_edition: Optional[str] = None,
        gateway_name: Optional[str] = None,
        gateway_type: Optional[str] = None,
        load_balancers: Optional[Sequence[GatewayLoadBalancerArgs]] = None,
        log_config: Optional[GatewayLogConfigArgs] = None,
        network_access_config: Optional[GatewayNetworkAccessConfigArgs] = None,
        payment_type: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        security_groups: Optional[Sequence[GatewaySecurityGroupArgs]] = None,
        spec: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        target_version: Optional[str] = None,
        update_time: Optional[int] = None,
        version: Optional[str] = None,
        vpc: Optional[GatewayVpcArgs] = None,
        vswitch: Optional[GatewayVswitchArgs] = None,
        zone_config: Optional[GatewayZoneConfigArgs] = None,
        zones: Optional[Sequence[GatewayZoneArgs]] = None) -> Gateway
    func GetGateway(ctx *Context, name string, id IDInput, state *GatewayState, opts ...ResourceOption) (*Gateway, error)
    public static Gateway Get(string name, Input<string> id, GatewayState? state, CustomResourceOptions? opts = null)
    public static Gateway get(String name, Output<String> id, GatewayState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:apig:Gateway    get:      id: ${id}
    import {
  to = alicloud_apig_gateway.example
  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.
    The following state arguments are supported:
    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Environments List<Pulumi.AliCloud.Apig.Inputs.GatewayEnvironment>
    The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    GatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    GatewayName string
    Query by exact match of the gateway name.
    GatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    LoadBalancers List<Pulumi.AliCloud.Apig.Inputs.GatewayLoadBalancer>
    The list of Gateway ingress addresses.
    LogConfig Pulumi.AliCloud.Apig.Inputs.GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    NetworkAccessConfig Pulumi.AliCloud.Apig.Inputs.GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    PaymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    ResourceGroupId string
    The ID of the destination resource group.
    SecurityGroups List<Pulumi.AliCloud.Apig.Inputs.GatewaySecurityGroup>
    The security group of the gateway.
    Spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    Status string
    The status of the gateway.
    Tags Dictionary<string, string>
    The tag of the resource
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    Version string
    The current running version of the gateway instance.
    Vpc Pulumi.AliCloud.Apig.Inputs.GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    Vswitch Pulumi.AliCloud.Apig.Inputs.GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    ZoneConfig Pulumi.AliCloud.Apig.Inputs.GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    Zones List<Pulumi.AliCloud.Apig.Inputs.GatewayZone>
    The list of zones associated with the gateway. See zones below.
    CreateFrom string
    The source from which the gateway was created.
    CreateTime int
    The creation timestamp. Unit: milliseconds.
    Environments []GatewayEnvironmentArgs
    The list of environments associated with the gateway.
    ExpireTime int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    GatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    GatewayName string
    Query by exact match of the gateway name.
    GatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    LoadBalancers []GatewayLoadBalancerArgs
    The list of Gateway ingress addresses.
    LogConfig GatewayLogConfigArgs
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    NetworkAccessConfig GatewayNetworkAccessConfigArgs
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    PaymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    ResourceGroupId string
    The ID of the destination resource group.
    SecurityGroups []GatewaySecurityGroupArgs
    The security group of the gateway.
    Spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    Status string
    The status of the gateway.
    Tags map[string]string
    The tag of the resource
    TargetVersion string
    The target version of the gateway instance.
    UpdateTime int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    Version string
    The current running version of the gateway instance.
    Vpc GatewayVpcArgs
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    Vswitch GatewayVswitchArgs
    The vSwitch associated with the gateway. See vswitch below.
    ZoneConfig GatewayZoneConfigArgs
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    Zones []GatewayZoneArgs
    The list of zones associated with the gateway. See zones below.
    create_from string
    The source from which the gateway was created.
    create_time number
    The creation timestamp. Unit: milliseconds.
    environments list(object)
    The list of environments associated with the gateway.
    expire_time number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    gateway_edition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gateway_name string
    Query by exact match of the gateway name.
    gateway_type string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    load_balancers list(object)
    The list of Gateway ingress addresses.
    log_config object
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    network_access_config object
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    payment_type string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    resource_group_id string
    The ID of the destination resource group.
    security_groups list(object)
    The security group of the gateway.
    spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    status string
    The status of the gateway.
    tags map(string)
    The tag of the resource
    target_version string
    The target version of the gateway instance.
    update_time number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version string
    The current running version of the gateway instance.
    vpc object
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch object
    The vSwitch associated with the gateway. See vswitch below.
    zone_config object
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    zones list(object)
    The list of zones associated with the gateway. See zones below.
    createFrom String
    The source from which the gateway was created.
    createTime Integer
    The creation timestamp. Unit: milliseconds.
    environments List<GatewayEnvironment>
    The list of environments associated with the gateway.
    expireTime Integer
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    gatewayEdition String
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName String
    Query by exact match of the gateway name.
    gatewayType String
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    loadBalancers List<GatewayLoadBalancer>
    The list of Gateway ingress addresses.
    logConfig GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    paymentType String
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    resourceGroupId String
    The ID of the destination resource group.
    securityGroups List<GatewaySecurityGroup>
    The security group of the gateway.
    spec String
    Gateway specification:

    • apigw.small.x1: Small specification.
    status String
    The status of the gateway.
    tags Map<String,String>
    The tag of the resource
    targetVersion String
    The target version of the gateway instance.
    updateTime Integer
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version String
    The current running version of the gateway instance.
    vpc GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    zoneConfig GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    zones List<GatewayZone>
    The list of zones associated with the gateway. See zones below.
    createFrom string
    The source from which the gateway was created.
    createTime number
    The creation timestamp. Unit: milliseconds.
    environments GatewayEnvironment[]
    The list of environments associated with the gateway.
    expireTime number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    gatewayEdition string
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName string
    Query by exact match of the gateway name.
    gatewayType string
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    loadBalancers GatewayLoadBalancer[]
    The list of Gateway ingress addresses.
    logConfig GatewayLogConfig
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig GatewayNetworkAccessConfig
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    paymentType string
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    resourceGroupId string
    The ID of the destination resource group.
    securityGroups GatewaySecurityGroup[]
    The security group of the gateway.
    spec string
    Gateway specification:

    • apigw.small.x1: Small specification.
    status string
    The status of the gateway.
    tags {[key: string]: string}
    The tag of the resource
    targetVersion string
    The target version of the gateway instance.
    updateTime number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version string
    The current running version of the gateway instance.
    vpc GatewayVpc
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitch
    The vSwitch associated with the gateway. See vswitch below.
    zoneConfig GatewayZoneConfig
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    zones GatewayZone[]
    The list of zones associated with the gateway. See zones below.
    create_from str
    The source from which the gateway was created.
    create_time int
    The creation timestamp. Unit: milliseconds.
    environments Sequence[GatewayEnvironmentArgs]
    The list of environments associated with the gateway.
    expire_time int
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    gateway_edition str
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gateway_name str
    Query by exact match of the gateway name.
    gateway_type str
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    load_balancers Sequence[GatewayLoadBalancerArgs]
    The list of Gateway ingress addresses.
    log_config GatewayLogConfigArgs
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    network_access_config GatewayNetworkAccessConfigArgs
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    payment_type str
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    resource_group_id str
    The ID of the destination resource group.
    security_groups Sequence[GatewaySecurityGroupArgs]
    The security group of the gateway.
    spec str
    Gateway specification:

    • apigw.small.x1: Small specification.
    status str
    The status of the gateway.
    tags Mapping[str, str]
    The tag of the resource
    target_version str
    The target version of the gateway instance.
    update_time int
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version str
    The current running version of the gateway instance.
    vpc GatewayVpcArgs
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch GatewayVswitchArgs
    The vSwitch associated with the gateway. See vswitch below.
    zone_config GatewayZoneConfigArgs
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    zones Sequence[GatewayZoneArgs]
    The list of zones associated with the gateway. See zones below.
    createFrom String
    The source from which the gateway was created.
    createTime Number
    The creation timestamp. Unit: milliseconds.
    environments List<Property Map>
    The list of environments associated with the gateway.
    expireTime Number
    Timestamp indicating when the subscription expires. Unit: milliseconds.
    gatewayEdition String
    Gateway instance edition. Valid values:

    • Professional: Standard instance.
    • Serverless: Serverless instance.
    • MultiTenantServerless: Multi-tenant Serverless instance.
    gatewayName String
    Query by exact match of the gateway name.
    gatewayType String
    The gateway type. Valid values:

    • API: API Gateway
    • AI: AI Gateway
    loadBalancers List<Property Map>
    The list of Gateway ingress addresses.
    logConfig Property Map
    The log configuration for the gateway instance. See logConfig below. Note: The parameter is immutable after resource creation.
    networkAccessConfig Property Map
    The network access type of the gateway instance. See networkAccessConfig below. Note: The parameter is immutable after resource creation.
    paymentType String
    Payment type. Valid values:

    • PayAsYouGo: Pay-as-you-go.
    • Subscription: Subscription.
    resourceGroupId String
    The ID of the destination resource group.
    securityGroups List<Property Map>
    The security group of the gateway.
    spec String
    Gateway specification:

    • apigw.small.x1: Small specification.
    status String
    The status of the gateway.
    tags Map<String>
    The tag of the resource
    targetVersion String
    The target version of the gateway instance.
    updateTime Number
    The timestamp when the gateway was last updated. Unit: milliseconds.
    version String
    The current running version of the gateway instance.
    vpc Property Map
    The Virtual Private Cloud (VPC) associated with the gateway. See vpc below.
    vswitch Property Map
    The vSwitch associated with the gateway. See vswitch below.
    zoneConfig Property Map
    The availability zone selection option for the gateway. See zoneConfig below. Note: The parameter is immutable after resource creation.
    zones List<Property Map>
    The list of zones associated with the gateway. See zones below.

    Supporting Types

    GatewayEnvironment, GatewayEnvironmentArgs

    Alias string
    The alias of the environment.
    EnvironmentId string
    The ID of the environment.
    Name string
    The name of the availability zone for the gateway.
    Alias string
    The alias of the environment.
    EnvironmentId string
    The ID of the environment.
    Name string
    The name of the availability zone for the gateway.
    alias string
    The alias of the environment.
    environment_id string
    The ID of the environment.
    name string
    The name of the availability zone for the gateway.
    alias String
    The alias of the environment.
    environmentId String
    The ID of the environment.
    name String
    The name of the availability zone for the gateway.
    alias string
    The alias of the environment.
    environmentId string
    The ID of the environment.
    name string
    The name of the availability zone for the gateway.
    alias str
    The alias of the environment.
    environment_id str
    The ID of the environment.
    name str
    The name of the availability zone for the gateway.
    alias String
    The alias of the environment.
    environmentId String
    The ID of the environment.
    name String
    The name of the availability zone for the gateway.

    GatewayLoadBalancer, GatewayLoadBalancerArgs

    Address string
    The address of the load balancer for the gateway.
    AddressIpVersion string
    The IP version of the load balancer.
    AddressType string
    The load balancer address type.
    GatewayDefault bool
    Indicates whether this is the default ingress address of the gateway.
    Ipv4Addresses List<string>
    The list of IPv4 addresses.
    Ipv6Addresses List<string>
    The list of IPv6 addresses.
    LoadBalancerId string
    The ID of the load balancer associated with the gateway.
    Mode string
    The load balancing provisioning mode for the gateway.
    Ports List<Pulumi.AliCloud.Apig.Inputs.GatewayLoadBalancerPort>
    The list of listening ports.
    Status string
    The status of the gateway.
    Type string
    The type of the load balancer.
    Address string
    The address of the load balancer for the gateway.
    AddressIpVersion string
    The IP version of the load balancer.
    AddressType string
    The load balancer address type.
    GatewayDefault bool
    Indicates whether this is the default ingress address of the gateway.
    Ipv4Addresses []string
    The list of IPv4 addresses.
    Ipv6Addresses []string
    The list of IPv6 addresses.
    LoadBalancerId string
    The ID of the load balancer associated with the gateway.
    Mode string
    The load balancing provisioning mode for the gateway.
    Ports []GatewayLoadBalancerPort
    The list of listening ports.
    Status string
    The status of the gateway.
    Type string
    The type of the load balancer.
    address string
    The address of the load balancer for the gateway.
    address_ip_version string
    The IP version of the load balancer.
    address_type string
    The load balancer address type.
    gateway_default bool
    Indicates whether this is the default ingress address of the gateway.
    ipv4_addresses list(string)
    The list of IPv4 addresses.
    ipv6_addresses list(string)
    The list of IPv6 addresses.
    load_balancer_id string
    The ID of the load balancer associated with the gateway.
    mode string
    The load balancing provisioning mode for the gateway.
    ports list(object)
    The list of listening ports.
    status string
    The status of the gateway.
    type string
    The type of the load balancer.
    address String
    The address of the load balancer for the gateway.
    addressIpVersion String
    The IP version of the load balancer.
    addressType String
    The load balancer address type.
    gatewayDefault Boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses List<String>
    The list of IPv4 addresses.
    ipv6Addresses List<String>
    The list of IPv6 addresses.
    loadBalancerId String
    The ID of the load balancer associated with the gateway.
    mode String
    The load balancing provisioning mode for the gateway.
    ports List<GatewayLoadBalancerPort>
    The list of listening ports.
    status String
    The status of the gateway.
    type String
    The type of the load balancer.
    address string
    The address of the load balancer for the gateway.
    addressIpVersion string
    The IP version of the load balancer.
    addressType string
    The load balancer address type.
    gatewayDefault boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses string[]
    The list of IPv4 addresses.
    ipv6Addresses string[]
    The list of IPv6 addresses.
    loadBalancerId string
    The ID of the load balancer associated with the gateway.
    mode string
    The load balancing provisioning mode for the gateway.
    ports GatewayLoadBalancerPort[]
    The list of listening ports.
    status string
    The status of the gateway.
    type string
    The type of the load balancer.
    address str
    The address of the load balancer for the gateway.
    address_ip_version str
    The IP version of the load balancer.
    address_type str
    The load balancer address type.
    gateway_default bool
    Indicates whether this is the default ingress address of the gateway.
    ipv4_addresses Sequence[str]
    The list of IPv4 addresses.
    ipv6_addresses Sequence[str]
    The list of IPv6 addresses.
    load_balancer_id str
    The ID of the load balancer associated with the gateway.
    mode str
    The load balancing provisioning mode for the gateway.
    ports Sequence[GatewayLoadBalancerPort]
    The list of listening ports.
    status str
    The status of the gateway.
    type str
    The type of the load balancer.
    address String
    The address of the load balancer for the gateway.
    addressIpVersion String
    The IP version of the load balancer.
    addressType String
    The load balancer address type.
    gatewayDefault Boolean
    Indicates whether this is the default ingress address of the gateway.
    ipv4Addresses List<String>
    The list of IPv4 addresses.
    ipv6Addresses List<String>
    The list of IPv6 addresses.
    loadBalancerId String
    The ID of the load balancer associated with the gateway.
    mode String
    The load balancing provisioning mode for the gateway.
    ports List<Property Map>
    The list of listening ports.
    status String
    The status of the gateway.
    type String
    The type of the load balancer.

    GatewayLoadBalancerPort, GatewayLoadBalancerPortArgs

    Port int
    The port number of the load balancer listener.
    Protocol string
    The protocol of the load balancer listener.
    Port int
    The port number of the load balancer listener.
    Protocol string
    The protocol of the load balancer listener.
    port number
    The port number of the load balancer listener.
    protocol string
    The protocol of the load balancer listener.
    port Integer
    The port number of the load balancer listener.
    protocol String
    The protocol of the load balancer listener.
    port number
    The port number of the load balancer listener.
    protocol string
    The protocol of the load balancer listener.
    port int
    The port number of the load balancer listener.
    protocol str
    The protocol of the load balancer listener.
    port Number
    The port number of the load balancer listener.
    protocol String
    The protocol of the load balancer listener.

    GatewayLogConfig, GatewayLogConfigArgs

    Sls Pulumi.AliCloud.Apig.Inputs.GatewayLogConfigSls
    The Simple Log Service configuration for the gateway. See sls below.
    Sls GatewayLogConfigSls
    The Simple Log Service configuration for the gateway. See sls below.
    sls object
    The Simple Log Service configuration for the gateway. See sls below.
    sls GatewayLogConfigSls
    The Simple Log Service configuration for the gateway. See sls below.
    sls GatewayLogConfigSls
    The Simple Log Service configuration for the gateway. See sls below.
    sls GatewayLogConfigSls
    The Simple Log Service configuration for the gateway. See sls below.
    sls Property Map
    The Simple Log Service configuration for the gateway. See sls below.

    GatewayLogConfigSls, GatewayLogConfigSlsArgs

    Enable bool
    The Simple Log Service configuration for the gateway.
    Enable bool
    The Simple Log Service configuration for the gateway.
    enable bool
    The Simple Log Service configuration for the gateway.
    enable Boolean
    The Simple Log Service configuration for the gateway.
    enable boolean
    The Simple Log Service configuration for the gateway.
    enable bool
    The Simple Log Service configuration for the gateway.
    enable Boolean
    The Simple Log Service configuration for the gateway.

    GatewayNetworkAccessConfig, GatewayNetworkAccessConfigArgs

    Type string
    The network access type of the gateway instance.
    Type string
    The network access type of the gateway instance.
    type string
    The network access type of the gateway instance.
    type String
    The network access type of the gateway instance.
    type string
    The network access type of the gateway instance.
    type str
    The network access type of the gateway instance.
    type String
    The network access type of the gateway instance.

    GatewaySecurityGroup, GatewaySecurityGroupArgs

    Name string
    The name of the availability zone for the gateway.
    SecurityGroupId string
    The ID of the security group.
    Name string
    The name of the availability zone for the gateway.
    SecurityGroupId string
    The ID of the security group.
    name string
    The name of the availability zone for the gateway.
    security_group_id string
    The ID of the security group.
    name String
    The name of the availability zone for the gateway.
    securityGroupId String
    The ID of the security group.
    name string
    The name of the availability zone for the gateway.
    securityGroupId string
    The ID of the security group.
    name str
    The name of the availability zone for the gateway.
    security_group_id str
    The ID of the security group.
    name String
    The name of the availability zone for the gateway.
    securityGroupId String
    The ID of the security group.

    GatewayVpc, GatewayVpcArgs

    VpcId string
    The ID of the VPC network associated with the gateway.
    Name string
    The name of the availability zone for the gateway.
    VpcId string
    The ID of the VPC network associated with the gateway.
    Name string
    The name of the availability zone for the gateway.
    vpc_id string
    The ID of the VPC network associated with the gateway.
    name string
    The name of the availability zone for the gateway.
    vpcId String
    The ID of the VPC network associated with the gateway.
    name String
    The name of the availability zone for the gateway.
    vpcId string
    The ID of the VPC network associated with the gateway.
    name string
    The name of the availability zone for the gateway.
    vpc_id str
    The ID of the VPC network associated with the gateway.
    name str
    The name of the availability zone for the gateway.
    vpcId String
    The ID of the VPC network associated with the gateway.
    name String
    The name of the availability zone for the gateway.

    GatewayVswitch, GatewayVswitchArgs

    Name string
    The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch.
    Name string
    The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch.
    name string
    The name of the availability zone for the gateway.
    vswitch_id string
    The ID of the virtual switch.
    name String
    The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch.
    name string
    The name of the availability zone for the gateway.
    vswitchId string
    The ID of the virtual switch.
    name str
    The name of the availability zone for the gateway.
    vswitch_id str
    The ID of the virtual switch.
    name String
    The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch.

    GatewayZone, GatewayZoneArgs

    Name string
    The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    ZoneId string
    The ID of the availability zone for the gateway.
    Name string
    The name of the availability zone for the gateway.
    VswitchId string
    The ID of the virtual switch in the availability zone.
    ZoneId string
    The ID of the availability zone for the gateway.
    name string
    The name of the availability zone for the gateway.
    vswitch_id string
    The ID of the virtual switch in the availability zone.
    zone_id string
    The ID of the availability zone for the gateway.
    name String
    The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.
    zoneId String
    The ID of the availability zone for the gateway.
    name string
    The name of the availability zone for the gateway.
    vswitchId string
    The ID of the virtual switch in the availability zone.
    zoneId string
    The ID of the availability zone for the gateway.
    name str
    The name of the availability zone for the gateway.
    vswitch_id str
    The ID of the virtual switch in the availability zone.
    zone_id str
    The ID of the availability zone for the gateway.
    name String
    The name of the availability zone for the gateway.
    vswitchId String
    The ID of the virtual switch in the availability zone.
    zoneId String
    The ID of the availability zone for the gateway.

    GatewayZoneConfig, GatewayZoneConfigArgs

    SelectOption string
    Zone selection option.
    SelectOption string
    Zone selection option.
    select_option string
    Zone selection option.
    selectOption String
    Zone selection option.
    selectOption string
    Zone selection option.
    select_option str
    Zone selection option.
    selectOption String
    Zone selection option.

    Import

    APIG Gateway can be imported using the id, e.g.

    $ pulumi import alicloud:apig/gateway:Gateway example <gateway_id>

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo alicloud logo
    Viewing docs for Alibaba Cloud v3.109.1
    published on Tuesday, Oct 13, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial