Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Opentelekomcloud Provider
  3. API Docs
  4. ApigwGatewayV2
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

opentelekomcloud.ApigwGatewayV2

Explore with Pulumi AI

opentelekomcloud logo
opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
opentelekomcloud/terraform-provider-opentelekomcloud

    Up-to-date reference of API arguments for API Gateway service you can get at documentation portal

    API Gateway (APIG) is a high-performance, high-availability, and high-security API hosting service that helps you build, manage, and deploy APIs at any scale. With just a few clicks, you can integrate internal systems, and selectively expose capabilities with minimal costs and risks.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as opentelekomcloud from "@pulumi/opentelekomcloud";

const gateway = new opentelekomcloud.ApigwGatewayV2("gateway", {
    specId: "BASIC",
    vpcId: _var.vpc_id,
    subnetId: _var.network_id,
    securityGroupId: _var.default_secgroup.id,
    availabilityZones: [
        "eu-de-01",
        "eu-de-02",
    ],
    description: "test gateway",
    bandwidthSize: 5,
    ingressBandwidthSize: 5,
    ingressBandwidthChargingMode: "bandwidth",
    maintainBegin: "22:00:00",
});

    import pulumi
import pulumi_opentelekomcloud as opentelekomcloud

gateway = opentelekomcloud.ApigwGatewayV2("gateway",
    spec_id="BASIC",
    vpc_id=var["vpc_id"],
    subnet_id=var["network_id"],
    security_group_id=var["default_secgroup"]["id"],
    availability_zones=[
        "eu-de-01",
        "eu-de-02",
    ],
    description="test gateway",
    bandwidth_size=5,
    ingress_bandwidth_size=5,
    ingress_bandwidth_charging_mode="bandwidth",
    maintain_begin="22:00:00")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/opentelekomcloud/opentelekomcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := opentelekomcloud.NewApigwGatewayV2(ctx, "gateway", &opentelekomcloud.ApigwGatewayV2Args{
			SpecId:          pulumi.String("BASIC"),
			VpcId:           pulumi.Any(_var.Vpc_id),
			SubnetId:        pulumi.Any(_var.Network_id),
			SecurityGroupId: pulumi.Any(_var.Default_secgroup.Id),
			AvailabilityZones: pulumi.StringArray{
				pulumi.String("eu-de-01"),
				pulumi.String("eu-de-02"),
			},
			Description:                  pulumi.String("test gateway"),
			BandwidthSize:                pulumi.Float64(5),
			IngressBandwidthSize:         pulumi.Float64(5),
			IngressBandwidthChargingMode: pulumi.String("bandwidth"),
			MaintainBegin:                pulumi.String("22:00:00"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Opentelekomcloud = Pulumi.Opentelekomcloud;

return await Deployment.RunAsync(() => 
{
    var gateway = new Opentelekomcloud.ApigwGatewayV2("gateway", new()
    {
        SpecId = "BASIC",
        VpcId = @var.Vpc_id,
        SubnetId = @var.Network_id,
        SecurityGroupId = @var.Default_secgroup.Id,
        AvailabilityZones = new[]
        {
            "eu-de-01",
            "eu-de-02",
        },
        Description = "test gateway",
        BandwidthSize = 5,
        IngressBandwidthSize = 5,
        IngressBandwidthChargingMode = "bandwidth",
        MaintainBegin = "22:00:00",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.opentelekomcloud.ApigwGatewayV2;
import com.pulumi.opentelekomcloud.ApigwGatewayV2Args;
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 gateway = new ApigwGatewayV2("gateway", ApigwGatewayV2Args.builder()
            .specId("BASIC")
            .vpcId(var_.vpc_id())
            .subnetId(var_.network_id())
            .securityGroupId(var_.default_secgroup().id())
            .availabilityZones(            
                "eu-de-01",
                "eu-de-02")
            .description("test gateway")
            .bandwidthSize(5)
            .ingressBandwidthSize(5)
            .ingressBandwidthChargingMode("bandwidth")
            .maintainBegin("22:00:00")
            .build());

    }
}

    resources:
  gateway:
    type: opentelekomcloud:ApigwGatewayV2
    properties:
      specId: BASIC
      vpcId: ${var.vpc_id}
      subnetId: ${var.network_id}
      securityGroupId: ${var.default_secgroup.id}
      availabilityZones:
        - eu-de-01
        - eu-de-02
      description: test gateway
      bandwidthSize: 5
      ingressBandwidthSize: 5
      ingressBandwidthChargingMode: bandwidth
      maintainBegin: 22:00:00

    Create ApigwGatewayV2 Resource

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

    Constructor syntax

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

@overload
def ApigwGatewayV2(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   security_group_id: Optional[str] = None,
                   availability_zones: Optional[Sequence[str]] = None,
                   vpc_id: Optional[str] = None,
                   subnet_id: Optional[str] = None,
                   spec_id: Optional[str] = None,
                   ingress_bandwidth_size: Optional[float] = None,
                   apigw_gateway_v2_id: Optional[str] = None,
                   loadbalancer_provider: Optional[str] = None,
                   maintain_begin: Optional[str] = None,
                   name: Optional[str] = None,
                   ingress_bandwidth_charging_mode: Optional[str] = None,
                   description: Optional[str] = None,
                   bandwidth_size: Optional[float] = None,
                   timeouts: Optional[ApigwGatewayV2TimeoutsArgs] = None,
                   bandwidth_charging_mode: Optional[str] = None)
    func NewApigwGatewayV2(ctx *Context, name string, args ApigwGatewayV2Args, opts ...ResourceOption) (*ApigwGatewayV2, error)
    public ApigwGatewayV2(string name, ApigwGatewayV2Args args, CustomResourceOptions? opts = null)
    public ApigwGatewayV2(String name, ApigwGatewayV2Args args)
public ApigwGatewayV2(String name, ApigwGatewayV2Args args, CustomResourceOptions options)

    type: opentelekomcloud:ApigwGatewayV2
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ApigwGatewayV2Args
    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 ApigwGatewayV2Args
    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 ApigwGatewayV2Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigwGatewayV2Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigwGatewayV2Args
    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 apigwGatewayV2Resource = new Opentelekomcloud.ApigwGatewayV2("apigwGatewayV2Resource", new()
{
    SecurityGroupId = "string",
    AvailabilityZones = new[]
    {
        "string",
    },
    VpcId = "string",
    SubnetId = "string",
    SpecId = "string",
    IngressBandwidthSize = 0,
    ApigwGatewayV2Id = "string",
    LoadbalancerProvider = "string",
    MaintainBegin = "string",
    Name = "string",
    IngressBandwidthChargingMode = "string",
    Description = "string",
    BandwidthSize = 0,
    Timeouts = new Opentelekomcloud.Inputs.ApigwGatewayV2TimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    BandwidthChargingMode = "string",
});

    example, err := opentelekomcloud.NewApigwGatewayV2(ctx, "apigwGatewayV2Resource", &opentelekomcloud.ApigwGatewayV2Args{
	SecurityGroupId: pulumi.String("string"),
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcId:                        pulumi.String("string"),
	SubnetId:                     pulumi.String("string"),
	SpecId:                       pulumi.String("string"),
	IngressBandwidthSize:         pulumi.Float64(0),
	ApigwGatewayV2Id:             pulumi.String("string"),
	LoadbalancerProvider:         pulumi.String("string"),
	MaintainBegin:                pulumi.String("string"),
	Name:                         pulumi.String("string"),
	IngressBandwidthChargingMode: pulumi.String("string"),
	Description:                  pulumi.String("string"),
	BandwidthSize:                pulumi.Float64(0),
	Timeouts: &opentelekomcloud.ApigwGatewayV2TimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	BandwidthChargingMode: pulumi.String("string"),
})

    var apigwGatewayV2Resource = new ApigwGatewayV2("apigwGatewayV2Resource", ApigwGatewayV2Args.builder()
    .securityGroupId("string")
    .availabilityZones("string")
    .vpcId("string")
    .subnetId("string")
    .specId("string")
    .ingressBandwidthSize(0)
    .apigwGatewayV2Id("string")
    .loadbalancerProvider("string")
    .maintainBegin("string")
    .name("string")
    .ingressBandwidthChargingMode("string")
    .description("string")
    .bandwidthSize(0)
    .timeouts(ApigwGatewayV2TimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .bandwidthChargingMode("string")
    .build());

    apigw_gateway_v2_resource = opentelekomcloud.ApigwGatewayV2("apigwGatewayV2Resource",
    security_group_id="string",
    availability_zones=["string"],
    vpc_id="string",
    subnet_id="string",
    spec_id="string",
    ingress_bandwidth_size=0,
    apigw_gateway_v2_id="string",
    loadbalancer_provider="string",
    maintain_begin="string",
    name="string",
    ingress_bandwidth_charging_mode="string",
    description="string",
    bandwidth_size=0,
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    bandwidth_charging_mode="string")

    const apigwGatewayV2Resource = new opentelekomcloud.ApigwGatewayV2("apigwGatewayV2Resource", {
    securityGroupId: "string",
    availabilityZones: ["string"],
    vpcId: "string",
    subnetId: "string",
    specId: "string",
    ingressBandwidthSize: 0,
    apigwGatewayV2Id: "string",
    loadbalancerProvider: "string",
    maintainBegin: "string",
    name: "string",
    ingressBandwidthChargingMode: "string",
    description: "string",
    bandwidthSize: 0,
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    bandwidthChargingMode: "string",
});

    type: opentelekomcloud:ApigwGatewayV2
properties:
    apigwGatewayV2Id: string
    availabilityZones:
        - string
    bandwidthChargingMode: string
    bandwidthSize: 0
    description: string
    ingressBandwidthChargingMode: string
    ingressBandwidthSize: 0
    loadbalancerProvider: string
    maintainBegin: string
    name: string
    securityGroupId: string
    specId: string
    subnetId: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcId: string

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

    AvailabilityZones List<string>
    Specifies gateway description.
    SecurityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    SpecId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    SubnetId string
    Specifies network ID.
    VpcId string
    Specifies VPC ID.
    ApigwGatewayV2Id string
    BandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    BandwidthSize double
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    Description string
    Specifies gateway description.
    IngressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    IngressBandwidthSize double
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    LoadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    MaintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    Name string
    Specifies gateway name.
    Timeouts ApigwGatewayV2Timeouts
    AvailabilityZones []string
    Specifies gateway description.
    SecurityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    SpecId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    SubnetId string
    Specifies network ID.
    VpcId string
    Specifies VPC ID.
    ApigwGatewayV2Id string
    BandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    BandwidthSize float64
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    Description string
    Specifies gateway description.
    IngressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    IngressBandwidthSize float64
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    LoadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    MaintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    Name string
    Specifies gateway name.
    Timeouts ApigwGatewayV2TimeoutsArgs
    availabilityZones List<String>
    Specifies gateway description.
    securityGroupId String
    Specifies ID of the security group to which the gateway belongs.
    specId String
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    subnetId String
    Specifies network ID.
    vpcId String
    Specifies VPC ID.
    apigwGatewayV2Id String
    bandwidthChargingMode String
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize Double
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description String
    Specifies gateway description.
    ingressBandwidthChargingMode String
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize Double
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider String
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin String
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    name String
    Specifies gateway name.
    timeouts ApigwGatewayV2Timeouts
    availabilityZones string[]
    Specifies gateway description.
    securityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    specId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    subnetId string
    Specifies network ID.
    vpcId string
    Specifies VPC ID.
    apigwGatewayV2Id string
    bandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize number
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description string
    Specifies gateway description.
    ingressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize number
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    name string
    Specifies gateway name.
    timeouts ApigwGatewayV2Timeouts
    availability_zones Sequence[str]
    Specifies gateway description.
    security_group_id str
    Specifies ID of the security group to which the gateway belongs.
    spec_id str
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    subnet_id str
    Specifies network ID.
    vpc_id str
    Specifies VPC ID.
    apigw_gateway_v2_id str
    bandwidth_charging_mode str
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidth_size float
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description str
    Specifies gateway description.
    ingress_bandwidth_charging_mode str
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingress_bandwidth_size float
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancer_provider str
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintain_begin str
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    name str
    Specifies gateway name.
    timeouts ApigwGatewayV2TimeoutsArgs
    availabilityZones List<String>
    Specifies gateway description.
    securityGroupId String
    Specifies ID of the security group to which the gateway belongs.
    specId String
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    subnetId String
    Specifies network ID.
    vpcId String
    Specifies VPC ID.
    apigwGatewayV2Id String
    bandwidthChargingMode String
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize Number
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description String
    Specifies gateway description.
    ingressBandwidthChargingMode String
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize Number
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider String
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin String
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    name String
    Specifies gateway name.
    timeouts Property Map

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MaintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    PrivateEgressAddresses List<string>
    List of private egress addresses. *
    ProjectId string
    Instance project id.
    PublicEgressAddress string
    IP address for public outbound access.
    Region string
    Instance region.
    Status string
    Instance status.
    SupportedFeatures List<string>
    Supported features.
    VpcIngressAddress string
    VPC ingress address.
    VpcepServiceName string
    Name of a VPC endpoint service.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    PrivateEgressAddresses []string
    List of private egress addresses. *
    ProjectId string
    Instance project id.
    PublicEgressAddress string
    IP address for public outbound access.
    Region string
    Instance region.
    Status string
    Instance status.
    SupportedFeatures []string
    Supported features.
    VpcIngressAddress string
    VPC ingress address.
    VpcepServiceName string
    Name of a VPC endpoint service.
    id String
    The provider-assigned unique ID for this managed resource.
    maintainEnd String
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    privateEgressAddresses List<String>
    List of private egress addresses. *
    projectId String
    Instance project id.
    publicEgressAddress String
    IP address for public outbound access.
    region String
    Instance region.
    status String
    Instance status.
    supportedFeatures List<String>
    Supported features.
    vpcIngressAddress String
    VPC ingress address.
    vpcepServiceName String
    Name of a VPC endpoint service.
    id string
    The provider-assigned unique ID for this managed resource.
    maintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    privateEgressAddresses string[]
    List of private egress addresses. *
    projectId string
    Instance project id.
    publicEgressAddress string
    IP address for public outbound access.
    region string
    Instance region.
    status string
    Instance status.
    supportedFeatures string[]
    Supported features.
    vpcIngressAddress string
    VPC ingress address.
    vpcepServiceName string
    Name of a VPC endpoint service.
    id str
    The provider-assigned unique ID for this managed resource.
    maintain_end str
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    private_egress_addresses Sequence[str]
    List of private egress addresses. *
    project_id str
    Instance project id.
    public_egress_address str
    IP address for public outbound access.
    region str
    Instance region.
    status str
    Instance status.
    supported_features Sequence[str]
    Supported features.
    vpc_ingress_address str
    VPC ingress address.
    vpcep_service_name str
    Name of a VPC endpoint service.
    id String
    The provider-assigned unique ID for this managed resource.
    maintainEnd String
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    privateEgressAddresses List<String>
    List of private egress addresses. *
    projectId String
    Instance project id.
    publicEgressAddress String
    IP address for public outbound access.
    region String
    Instance region.
    status String
    Instance status.
    supportedFeatures List<String>
    Supported features.
    vpcIngressAddress String
    VPC ingress address.
    vpcepServiceName String
    Name of a VPC endpoint service.

    Look up Existing ApigwGatewayV2 Resource

    Get an existing ApigwGatewayV2 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?: ApigwGatewayV2State, opts?: CustomResourceOptions): ApigwGatewayV2
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apigw_gateway_v2_id: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        bandwidth_charging_mode: Optional[str] = None,
        bandwidth_size: Optional[float] = None,
        description: Optional[str] = None,
        ingress_bandwidth_charging_mode: Optional[str] = None,
        ingress_bandwidth_size: Optional[float] = None,
        loadbalancer_provider: Optional[str] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        name: Optional[str] = None,
        private_egress_addresses: Optional[Sequence[str]] = None,
        project_id: Optional[str] = None,
        public_egress_address: Optional[str] = None,
        region: Optional[str] = None,
        security_group_id: Optional[str] = None,
        spec_id: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        supported_features: Optional[Sequence[str]] = None,
        timeouts: Optional[ApigwGatewayV2TimeoutsArgs] = None,
        vpc_id: Optional[str] = None,
        vpc_ingress_address: Optional[str] = None,
        vpcep_service_name: Optional[str] = None) -> ApigwGatewayV2
    func GetApigwGatewayV2(ctx *Context, name string, id IDInput, state *ApigwGatewayV2State, opts ...ResourceOption) (*ApigwGatewayV2, error)
    public static ApigwGatewayV2 Get(string name, Input<string> id, ApigwGatewayV2State? state, CustomResourceOptions? opts = null)
    public static ApigwGatewayV2 get(String name, Output<String> id, ApigwGatewayV2State state, CustomResourceOptions options)
    resources:  _:    type: opentelekomcloud:ApigwGatewayV2    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApigwGatewayV2Id string
    AvailabilityZones List<string>
    Specifies gateway description.
    BandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    BandwidthSize double
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    Description string
    Specifies gateway description.
    IngressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    IngressBandwidthSize double
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    LoadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    MaintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    MaintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    Name string
    Specifies gateway name.
    PrivateEgressAddresses List<string>
    List of private egress addresses. *
    ProjectId string
    Instance project id.
    PublicEgressAddress string
    IP address for public outbound access.
    Region string
    Instance region.
    SecurityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    SpecId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    Status string
    Instance status.
    SubnetId string
    Specifies network ID.
    SupportedFeatures List<string>
    Supported features.
    Timeouts ApigwGatewayV2Timeouts
    VpcId string
    Specifies VPC ID.
    VpcIngressAddress string
    VPC ingress address.
    VpcepServiceName string
    Name of a VPC endpoint service.
    ApigwGatewayV2Id string
    AvailabilityZones []string
    Specifies gateway description.
    BandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    BandwidthSize float64
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    Description string
    Specifies gateway description.
    IngressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    IngressBandwidthSize float64
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    LoadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    MaintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    MaintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    Name string
    Specifies gateway name.
    PrivateEgressAddresses []string
    List of private egress addresses. *
    ProjectId string
    Instance project id.
    PublicEgressAddress string
    IP address for public outbound access.
    Region string
    Instance region.
    SecurityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    SpecId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    Status string
    Instance status.
    SubnetId string
    Specifies network ID.
    SupportedFeatures []string
    Supported features.
    Timeouts ApigwGatewayV2TimeoutsArgs
    VpcId string
    Specifies VPC ID.
    VpcIngressAddress string
    VPC ingress address.
    VpcepServiceName string
    Name of a VPC endpoint service.
    apigwGatewayV2Id String
    availabilityZones List<String>
    Specifies gateway description.
    bandwidthChargingMode String
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize Double
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description String
    Specifies gateway description.
    ingressBandwidthChargingMode String
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize Double
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider String
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin String
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    maintainEnd String
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    name String
    Specifies gateway name.
    privateEgressAddresses List<String>
    List of private egress addresses. *
    projectId String
    Instance project id.
    publicEgressAddress String
    IP address for public outbound access.
    region String
    Instance region.
    securityGroupId String
    Specifies ID of the security group to which the gateway belongs.
    specId String
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    status String
    Instance status.
    subnetId String
    Specifies network ID.
    supportedFeatures List<String>
    Supported features.
    timeouts ApigwGatewayV2Timeouts
    vpcId String
    Specifies VPC ID.
    vpcIngressAddress String
    VPC ingress address.
    vpcepServiceName String
    Name of a VPC endpoint service.
    apigwGatewayV2Id string
    availabilityZones string[]
    Specifies gateway description.
    bandwidthChargingMode string
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize number
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description string
    Specifies gateway description.
    ingressBandwidthChargingMode string
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize number
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider string
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin string
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    maintainEnd string
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    name string
    Specifies gateway name.
    privateEgressAddresses string[]
    List of private egress addresses. *
    projectId string
    Instance project id.
    publicEgressAddress string
    IP address for public outbound access.
    region string
    Instance region.
    securityGroupId string
    Specifies ID of the security group to which the gateway belongs.
    specId string
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    status string
    Instance status.
    subnetId string
    Specifies network ID.
    supportedFeatures string[]
    Supported features.
    timeouts ApigwGatewayV2Timeouts
    vpcId string
    Specifies VPC ID.
    vpcIngressAddress string
    VPC ingress address.
    vpcepServiceName string
    Name of a VPC endpoint service.
    apigw_gateway_v2_id str
    availability_zones Sequence[str]
    Specifies gateway description.
    bandwidth_charging_mode str
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidth_size float
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description str
    Specifies gateway description.
    ingress_bandwidth_charging_mode str
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingress_bandwidth_size float
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancer_provider str
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintain_begin str
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    maintain_end str
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    name str
    Specifies gateway name.
    private_egress_addresses Sequence[str]
    List of private egress addresses. *
    project_id str
    Instance project id.
    public_egress_address str
    IP address for public outbound access.
    region str
    Instance region.
    security_group_id str
    Specifies ID of the security group to which the gateway belongs.
    spec_id str
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    status str
    Instance status.
    subnet_id str
    Specifies network ID.
    supported_features Sequence[str]
    Supported features.
    timeouts ApigwGatewayV2TimeoutsArgs
    vpc_id str
    Specifies VPC ID.
    vpc_ingress_address str
    VPC ingress address.
    vpcep_service_name str
    Name of a VPC endpoint service.
    apigwGatewayV2Id String
    availabilityZones List<String>
    Specifies gateway description.
    bandwidthChargingMode String
    Billing type of the public outbound access bandwidth. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    bandwidthSize Number
    Specifies outbound access bandwidth. This parameter is required if public outbound access is enabled for the gateway. After you configure the bandwidth for the gateway, users can access resources on public networks.
    description String
    Specifies gateway description.
    ingressBandwidthChargingMode String
    Specifies the ingress bandwidth billing type of the dedicated instance. The valid values are as follows:

    • bandwidth: Billed by bandwidth.
    • traffic: Billed by traffic.
    ingressBandwidthSize Number
    Specifies public inbound access bandwidth. This parameter is required if public inbound access is enabled for the gateway and loadbalancer_provider is set to elb. After you bind an EIP to the gateway, users can access APIs in the gateway from public networks using the EIP.
    loadbalancerProvider String
    Specifies type of the load balancer used by the gateway. This resource provides the following timeouts configuration options:
    maintainBegin String
    Specifies start time of the maintenance time window. It must be in the format "xx:00:00". The value of xx can be 02, 06, 10, 14, 18, or 22.
    maintainEnd String
    End time of the maintenance time window. It must be in the format "xx:00:00". There is a 4-hour difference between the start time and end time.
    name String
    Specifies gateway name.
    privateEgressAddresses List<String>
    List of private egress addresses. *
    projectId String
    Instance project id.
    publicEgressAddress String
    IP address for public outbound access.
    region String
    Instance region.
    securityGroupId String
    Specifies ID of the security group to which the gateway belongs.
    specId String
    Gateway edition. Options: This resource provides the following timeouts configuration options:

    • BASIC
    • PROFESSIONAL
    • ENTERPRISE
    • PLATINUM
    status String
    Instance status.
    subnetId String
    Specifies network ID.
    supportedFeatures List<String>
    Supported features.
    timeouts Property Map
    vpcId String
    Specifies VPC ID.
    vpcIngressAddress String
    VPC ingress address.
    vpcepServiceName String
    Name of a VPC endpoint service.

    Supporting Types

    ApigwGatewayV2Timeouts, ApigwGatewayV2TimeoutsArgs

    Create string
    Delete string
    Update string
    Create string
    Delete string
    Update string
    create String
    delete String
    update String
    create string
    delete string
    update string
    create str
    delete str
    update str
    create String
    delete String
    update String

    Import

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

    $ pulumi import opentelekomcloud:index/apigwGatewayV2:ApigwGatewayV2 gateway c1881895-cdcb-4d23-96cb-032e6a3ee667

    Note that the imported state may not be identical to your resource definition, due to ingress_bandwidth_size missing from the

    API response. It is generally recommended running pulumi preview after importing a gateway.

    resource “opentelekomcloud_apigw_gateway_v2” “gateway” {

    ...

    lifecycle {

    ignore_changes = [

  ingress_bandwidth_size,

  ingress_bandwidth_charging_mode,

  bandwidth_charging_mode

]

    }

    }

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

    Package Details

    Repository
    opentelekomcloud opentelekomcloud/terraform-provider-opentelekomcloud
    License
    Notes
    This Pulumi package is based on the opentelekomcloud Terraform Provider.
    opentelekomcloud logo
    opentelekomcloud 1.36.37 published on Thursday, Apr 24, 2025 by opentelekomcloud
    opentelekomcloud/terraform-provider-opentelekomcloud