Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. ApigInstance
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.ApigInstance

Explore with Pulumi AI

flexibleengine logo
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

    Manages an APIG dedicated instance resource within FlexibleEngine.

    Example Usage

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

const config = new pulumi.Config();
const instanceName = config.requireObject("instanceName");
const exampleVpc = new flexibleengine.VpcV1("exampleVpc", {cidr: "192.168.0.0/16"});
const exampleSubnet = new flexibleengine.VpcSubnetV1("exampleSubnet", {
    cidr: "192.168.0.0/24",
    gatewayIp: "192.168.0.1",
    vpcId: exampleVpc.vpcV1Id,
});
const exampleSecgroup = new flexibleengine.NetworkingSecgroupV2("exampleSecgroup", {description: "My neutron security group"});
const exampleEip = new flexibleengine.VpcEip("exampleEip", {
    publicip: {
        type: "5_bgp",
    },
    bandwidth: {
        name: "test",
        size: 10,
        shareType: "PER",
    },
});
const az = flexibleengine.getAvailabilityZones({});
const exampleApigInstance = new flexibleengine.ApigInstance("exampleApigInstance", {
    edition: "BASIC",
    vpcId: exampleVpc.vpcV1Id,
    subnetId: exampleSubnet.vpcSubnetV1Id,
    securityGroupId: exampleSecgroup.networkingSecgroupV2Id,
    maintainBegin: "06:00:00",
    description: "Created by script",
    bandwidthSize: 3,
    eipId: exampleEip.vpcEipId,
    availableZones: [
        az.then(az => az.names?.[0]),
        az.then(az => az.names?.[1]),
    ],
});

    import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_name = config.require_object("instanceName")
example_vpc = flexibleengine.VpcV1("exampleVpc", cidr="192.168.0.0/16")
example_subnet = flexibleengine.VpcSubnetV1("exampleSubnet",
    cidr="192.168.0.0/24",
    gateway_ip="192.168.0.1",
    vpc_id=example_vpc.vpc_v1_id)
example_secgroup = flexibleengine.NetworkingSecgroupV2("exampleSecgroup", description="My neutron security group")
example_eip = flexibleengine.VpcEip("exampleEip",
    publicip={
        "type": "5_bgp",
    },
    bandwidth={
        "name": "test",
        "size": 10,
        "share_type": "PER",
    })
az = flexibleengine.get_availability_zones()
example_apig_instance = flexibleengine.ApigInstance("exampleApigInstance",
    edition="BASIC",
    vpc_id=example_vpc.vpc_v1_id,
    subnet_id=example_subnet.vpc_subnet_v1_id,
    security_group_id=example_secgroup.networking_secgroup_v2_id,
    maintain_begin="06:00:00",
    description="Created by script",
    bandwidth_size=3,
    eip_id=example_eip.vpc_eip_id,
    available_zones=[
        az.names[0],
        az.names[1],
    ])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"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, "")
		instanceName := cfg.RequireObject("instanceName")
		exampleVpc, err := flexibleengine.NewVpcV1(ctx, "exampleVpc", &flexibleengine.VpcV1Args{
			Cidr: pulumi.String("192.168.0.0/16"),
		})
		if err != nil {
			return err
		}
		exampleSubnet, err := flexibleengine.NewVpcSubnetV1(ctx, "exampleSubnet", &flexibleengine.VpcSubnetV1Args{
			Cidr:      pulumi.String("192.168.0.0/24"),
			GatewayIp: pulumi.String("192.168.0.1"),
			VpcId:     exampleVpc.VpcV1Id,
		})
		if err != nil {
			return err
		}
		exampleSecgroup, err := flexibleengine.NewNetworkingSecgroupV2(ctx, "exampleSecgroup", &flexibleengine.NetworkingSecgroupV2Args{
			Description: pulumi.String("My neutron security group"),
		})
		if err != nil {
			return err
		}
		exampleEip, err := flexibleengine.NewVpcEip(ctx, "exampleEip", &flexibleengine.VpcEipArgs{
			Publicip: &flexibleengine.VpcEipPublicipArgs{
				Type: pulumi.String("5_bgp"),
			},
			Bandwidth: &flexibleengine.VpcEipBandwidthArgs{
				Name:      pulumi.String("test"),
				Size:      pulumi.Float64(10),
				ShareType: pulumi.String("PER"),
			},
		})
		if err != nil {
			return err
		}
		az, err := flexibleengine.GetAvailabilityZones(ctx, &flexibleengine.GetAvailabilityZonesArgs{}, nil)
		if err != nil {
			return err
		}
		_, err = flexibleengine.NewApigInstance(ctx, "exampleApigInstance", &flexibleengine.ApigInstanceArgs{
			Edition:         pulumi.String("BASIC"),
			VpcId:           exampleVpc.VpcV1Id,
			SubnetId:        exampleSubnet.VpcSubnetV1Id,
			SecurityGroupId: exampleSecgroup.NetworkingSecgroupV2Id,
			MaintainBegin:   pulumi.String("06:00:00"),
			Description:     pulumi.String("Created by script"),
			BandwidthSize:   pulumi.Float64(3),
			EipId:           exampleEip.VpcEipId,
			AvailableZones: pulumi.StringArray{
				pulumi.String(az.Names[0]),
				pulumi.String(az.Names[1]),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceName = config.RequireObject<dynamic>("instanceName");
    var exampleVpc = new Flexibleengine.VpcV1("exampleVpc", new()
    {
        Cidr = "192.168.0.0/16",
    });

    var exampleSubnet = new Flexibleengine.VpcSubnetV1("exampleSubnet", new()
    {
        Cidr = "192.168.0.0/24",
        GatewayIp = "192.168.0.1",
        VpcId = exampleVpc.VpcV1Id,
    });

    var exampleSecgroup = new Flexibleengine.NetworkingSecgroupV2("exampleSecgroup", new()
    {
        Description = "My neutron security group",
    });

    var exampleEip = new Flexibleengine.VpcEip("exampleEip", new()
    {
        Publicip = new Flexibleengine.Inputs.VpcEipPublicipArgs
        {
            Type = "5_bgp",
        },
        Bandwidth = new Flexibleengine.Inputs.VpcEipBandwidthArgs
        {
            Name = "test",
            Size = 10,
            ShareType = "PER",
        },
    });

    var az = Flexibleengine.GetAvailabilityZones.Invoke();

    var exampleApigInstance = new Flexibleengine.ApigInstance("exampleApigInstance", new()
    {
        Edition = "BASIC",
        VpcId = exampleVpc.VpcV1Id,
        SubnetId = exampleSubnet.VpcSubnetV1Id,
        SecurityGroupId = exampleSecgroup.NetworkingSecgroupV2Id,
        MaintainBegin = "06:00:00",
        Description = "Created by script",
        BandwidthSize = 3,
        EipId = exampleEip.VpcEipId,
        AvailableZones = new[]
        {
            az.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[0]),
            az.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.Names[1]),
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.VpcV1;
import com.pulumi.flexibleengine.VpcV1Args;
import com.pulumi.flexibleengine.VpcSubnetV1;
import com.pulumi.flexibleengine.VpcSubnetV1Args;
import com.pulumi.flexibleengine.NetworkingSecgroupV2;
import com.pulumi.flexibleengine.NetworkingSecgroupV2Args;
import com.pulumi.flexibleengine.VpcEip;
import com.pulumi.flexibleengine.VpcEipArgs;
import com.pulumi.flexibleengine.inputs.VpcEipPublicipArgs;
import com.pulumi.flexibleengine.inputs.VpcEipBandwidthArgs;
import com.pulumi.flexibleengine.FlexibleengineFunctions;
import com.pulumi.flexibleengine.inputs.GetAvailabilityZonesArgs;
import com.pulumi.flexibleengine.ApigInstance;
import com.pulumi.flexibleengine.ApigInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var instanceName = config.get("instanceName");
        var exampleVpc = new VpcV1("exampleVpc", VpcV1Args.builder()
            .cidr("192.168.0.0/16")
            .build());

        var exampleSubnet = new VpcSubnetV1("exampleSubnet", VpcSubnetV1Args.builder()
            .cidr("192.168.0.0/24")
            .gatewayIp("192.168.0.1")
            .vpcId(exampleVpc.vpcV1Id())
            .build());

        var exampleSecgroup = new NetworkingSecgroupV2("exampleSecgroup", NetworkingSecgroupV2Args.builder()
            .description("My neutron security group")
            .build());

        var exampleEip = new VpcEip("exampleEip", VpcEipArgs.builder()
            .publicip(VpcEipPublicipArgs.builder()
                .type("5_bgp")
                .build())
            .bandwidth(VpcEipBandwidthArgs.builder()
                .name("test")
                .size(10)
                .shareType("PER")
                .build())
            .build());

        final var az = FlexibleengineFunctions.getAvailabilityZones();

        var exampleApigInstance = new ApigInstance("exampleApigInstance", ApigInstanceArgs.builder()
            .edition("BASIC")
            .vpcId(exampleVpc.vpcV1Id())
            .subnetId(exampleSubnet.vpcSubnetV1Id())
            .securityGroupId(exampleSecgroup.networkingSecgroupV2Id())
            .maintainBegin("06:00:00")
            .description("Created by script")
            .bandwidthSize(3)
            .eipId(exampleEip.vpcEipId())
            .availableZones(            
                az.applyValue(getAvailabilityZonesResult -> getAvailabilityZonesResult.names()[0]),
                az.applyValue(getAvailabilityZonesResult -> getAvailabilityZonesResult.names()[1]))
            .build());

    }
}

    configuration:
  instanceName:
    type: dynamic
resources:
  exampleVpc:
    type: flexibleengine:VpcV1
    properties:
      cidr: 192.168.0.0/16
  exampleSubnet:
    type: flexibleengine:VpcSubnetV1
    properties:
      cidr: 192.168.0.0/24
      gatewayIp: 192.168.0.1
      vpcId: ${exampleVpc.vpcV1Id}
  exampleSecgroup:
    type: flexibleengine:NetworkingSecgroupV2
    properties:
      description: My neutron security group
  exampleEip:
    type: flexibleengine:VpcEip
    properties:
      publicip:
        type: 5_bgp
      bandwidth:
        name: test
        size: 10
        shareType: PER
  exampleApigInstance:
    type: flexibleengine:ApigInstance
    properties:
      edition: BASIC
      vpcId: ${exampleVpc.vpcV1Id}
      subnetId: ${exampleSubnet.vpcSubnetV1Id}
      securityGroupId: ${exampleSecgroup.networkingSecgroupV2Id}
      maintainBegin: 06:00:00
      description: Created by script
      bandwidthSize: 3
      eipId: ${exampleEip.vpcEipId}
      availableZones:
        - ${az.names[0]}
        - ${az.names[1]}
variables:
  az:
    fn::invoke:
      function: flexibleengine:getAvailabilityZones
      arguments: {}

    Create ApigInstance Resource

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

    Constructor syntax

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

@overload
def ApigInstance(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 edition: Optional[str] = None,
                 vpc_id: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 security_group_id: Optional[str] = None,
                 ipv6_enable: Optional[bool] = None,
                 name: Optional[str] = None,
                 eip_id: Optional[str] = None,
                 enterprise_project_id: Optional[str] = None,
                 apig_instance_id: Optional[str] = None,
                 loadbalancer_provider: Optional[str] = None,
                 maintain_begin: Optional[str] = None,
                 description: Optional[str] = None,
                 region: Optional[str] = None,
                 bandwidth_size: Optional[float] = None,
                 available_zones: Optional[Sequence[str]] = None,
                 tags: Optional[Mapping[str, str]] = None,
                 timeouts: Optional[ApigInstanceTimeoutsArgs] = None,
                 availability_zones: Optional[Sequence[str]] = None,
                 vpcep_service_name: Optional[str] = None)
    func NewApigInstance(ctx *Context, name string, args ApigInstanceArgs, opts ...ResourceOption) (*ApigInstance, error)
    public ApigInstance(string name, ApigInstanceArgs args, CustomResourceOptions? opts = null)
    public ApigInstance(String name, ApigInstanceArgs args)
public ApigInstance(String name, ApigInstanceArgs args, CustomResourceOptions options)

    type: flexibleengine:ApigInstance
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 ApigInstanceArgs
    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 ApigInstanceArgs
    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 ApigInstanceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApigInstanceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApigInstanceArgs
    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 apigInstanceResource = new Flexibleengine.ApigInstance("apigInstanceResource", new()
{
    Edition = "string",
    VpcId = "string",
    SubnetId = "string",
    SecurityGroupId = "string",
    Ipv6Enable = false,
    Name = "string",
    EipId = "string",
    EnterpriseProjectId = "string",
    ApigInstanceId = "string",
    LoadbalancerProvider = "string",
    MaintainBegin = "string",
    Description = "string",
    Region = "string",
    BandwidthSize = 0,
    AvailableZones = new[]
    {
        "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
    Timeouts = new Flexibleengine.Inputs.ApigInstanceTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    AvailabilityZones = new[]
    {
        "string",
    },
    VpcepServiceName = "string",
});

    example, err := flexibleengine.NewApigInstance(ctx, "apigInstanceResource", &flexibleengine.ApigInstanceArgs{
	Edition:              pulumi.String("string"),
	VpcId:                pulumi.String("string"),
	SubnetId:             pulumi.String("string"),
	SecurityGroupId:      pulumi.String("string"),
	Ipv6Enable:           pulumi.Bool(false),
	Name:                 pulumi.String("string"),
	EipId:                pulumi.String("string"),
	EnterpriseProjectId:  pulumi.String("string"),
	ApigInstanceId:       pulumi.String("string"),
	LoadbalancerProvider: pulumi.String("string"),
	MaintainBegin:        pulumi.String("string"),
	Description:          pulumi.String("string"),
	Region:               pulumi.String("string"),
	BandwidthSize:        pulumi.Float64(0),
	AvailableZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Timeouts: &flexibleengine.ApigInstanceTimeoutsArgs{
		Create: pulumi.String("string"),
		Delete: pulumi.String("string"),
		Update: pulumi.String("string"),
	},
	AvailabilityZones: pulumi.StringArray{
		pulumi.String("string"),
	},
	VpcepServiceName: pulumi.String("string"),
})

    var apigInstanceResource = new ApigInstance("apigInstanceResource", ApigInstanceArgs.builder()
    .edition("string")
    .vpcId("string")
    .subnetId("string")
    .securityGroupId("string")
    .ipv6Enable(false)
    .name("string")
    .eipId("string")
    .enterpriseProjectId("string")
    .apigInstanceId("string")
    .loadbalancerProvider("string")
    .maintainBegin("string")
    .description("string")
    .region("string")
    .bandwidthSize(0)
    .availableZones("string")
    .tags(Map.of("string", "string"))
    .timeouts(ApigInstanceTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .availabilityZones("string")
    .vpcepServiceName("string")
    .build());

    apig_instance_resource = flexibleengine.ApigInstance("apigInstanceResource",
    edition="string",
    vpc_id="string",
    subnet_id="string",
    security_group_id="string",
    ipv6_enable=False,
    name="string",
    eip_id="string",
    enterprise_project_id="string",
    apig_instance_id="string",
    loadbalancer_provider="string",
    maintain_begin="string",
    description="string",
    region="string",
    bandwidth_size=0,
    available_zones=["string"],
    tags={
        "string": "string",
    },
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    availability_zones=["string"],
    vpcep_service_name="string")

    const apigInstanceResource = new flexibleengine.ApigInstance("apigInstanceResource", {
    edition: "string",
    vpcId: "string",
    subnetId: "string",
    securityGroupId: "string",
    ipv6Enable: false,
    name: "string",
    eipId: "string",
    enterpriseProjectId: "string",
    apigInstanceId: "string",
    loadbalancerProvider: "string",
    maintainBegin: "string",
    description: "string",
    region: "string",
    bandwidthSize: 0,
    availableZones: ["string"],
    tags: {
        string: "string",
    },
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    availabilityZones: ["string"],
    vpcepServiceName: "string",
});

    type: flexibleengine:ApigInstance
properties:
    apigInstanceId: string
    availabilityZones:
        - string
    availableZones:
        - string
    bandwidthSize: 0
    description: string
    edition: string
    eipId: string
    enterpriseProjectId: string
    ipv6Enable: false
    loadbalancerProvider: string
    maintainBegin: string
    name: string
    region: string
    securityGroupId: string
    subnetId: string
    tags:
        string: string
    timeouts:
        create: string
        delete: string
        update: string
    vpcId: string
    vpcepServiceName: string

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

    Edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    SecurityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    SubnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    VpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    ApigInstanceId string
    ID of the APIG dedicated instance.
    AvailabilityZones List<string>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    AvailableZones List<string>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    BandwidthSize double
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    Description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    EipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    EnterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    Ipv6Enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    LoadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    MaintainBegin string
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    Name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    Tags Dictionary<string, string>
    Timeouts ApigInstanceTimeouts
    VpcepServiceName string
    Name of the VPC endpoint service.
    Edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    SecurityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    SubnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    VpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    ApigInstanceId string
    ID of the APIG dedicated instance.
    AvailabilityZones []string
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    AvailableZones []string
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    BandwidthSize float64
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    Description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    EipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    EnterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    Ipv6Enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    LoadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    MaintainBegin string
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    Name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    Tags map[string]string
    Timeouts ApigInstanceTimeoutsArgs
    VpcepServiceName string
    Name of the VPC endpoint service.
    edition String
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    securityGroupId String
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    subnetId String
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcId String
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    apigInstanceId String
    ID of the APIG dedicated instance.
    availabilityZones List<String>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones List<String>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize Double
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    description String
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    eipId String
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId String
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ipv6Enable Boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider String

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin String
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    name String
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    tags Map<String,String>
    timeouts ApigInstanceTimeouts
    vpcepServiceName String
    Name of the VPC endpoint service.
    edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    securityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    subnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    apigInstanceId string
    ID of the APIG dedicated instance.
    availabilityZones string[]
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones string[]
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize number
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    eipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ipv6Enable boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin string
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    tags {[key: string]: string}
    timeouts ApigInstanceTimeouts
    vpcepServiceName string
    Name of the VPC endpoint service.
    edition str
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    security_group_id str
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    subnet_id str
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpc_id str
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    apig_instance_id str
    ID of the APIG dedicated instance.
    availability_zones Sequence[str]
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    available_zones Sequence[str]
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidth_size float
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    description str
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    eip_id str
    Specifies the eip ID associated with the APIG dedicated instance.
    enterprise_project_id str
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ipv6_enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancer_provider str

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintain_begin str
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    name str
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    tags Mapping[str, str]
    timeouts ApigInstanceTimeoutsArgs
    vpcep_service_name str
    Name of the VPC endpoint service.
    edition String
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    securityGroupId String
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    subnetId String
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcId String
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    apigInstanceId String
    ID of the APIG dedicated instance.
    availabilityZones List<String>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones List<String>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize Number
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    description String
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    eipId String
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId String
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ipv6Enable Boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider String

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin String
    Specifies a start time of the maintenance time window in the format 'xx:00:00'. The value of xx can be 02, 06, 10, 14, 18 or 22.
    name String
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    tags Map<String>
    timeouts Property Map
    vpcepServiceName String
    Name of the VPC endpoint service.

    Outputs

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

    CreateTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    CreatedAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    EgressAddress string
    The egress (nat) public ip address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IngressAddress string
    The ingress eip address.
    MaintainEnd string
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    Status string
    Status of the APIG dedicated instance.
    SupportedFeatures List<string>
    The supported features of the APIG dedicated instance.
    VpcIngressAddress string
    The ingress private ip address of vpc.
    VpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    CreateTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    CreatedAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    EgressAddress string
    The egress (nat) public ip address.
    Id string
    The provider-assigned unique ID for this managed resource.
    IngressAddress string
    The ingress eip address.
    MaintainEnd string
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    Status string
    Status of the APIG dedicated instance.
    SupportedFeatures []string
    The supported features of the APIG dedicated instance.
    VpcIngressAddress string
    The ingress private ip address of vpc.
    VpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    createTime String
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt String
    Time when the dedicated instance is created, in RFC-3339 format.
    egressAddress String
    The egress (nat) public ip address.
    id String
    The provider-assigned unique ID for this managed resource.
    ingressAddress String
    The ingress eip address.
    maintainEnd String
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    status String
    Status of the APIG dedicated instance.
    supportedFeatures List<String>
    The supported features of the APIG dedicated instance.
    vpcIngressAddress String
    The ingress private ip address of vpc.
    vpcepServiceAddress String
    The address (full name) of the VPC endpoint service.
    createTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    egressAddress string
    The egress (nat) public ip address.
    id string
    The provider-assigned unique ID for this managed resource.
    ingressAddress string
    The ingress eip address.
    maintainEnd string
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    status string
    Status of the APIG dedicated instance.
    supportedFeatures string[]
    The supported features of the APIG dedicated instance.
    vpcIngressAddress string
    The ingress private ip address of vpc.
    vpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    create_time str
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    created_at str
    Time when the dedicated instance is created, in RFC-3339 format.
    egress_address str
    The egress (nat) public ip address.
    id str
    The provider-assigned unique ID for this managed resource.
    ingress_address str
    The ingress eip address.
    maintain_end str
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    status str
    Status of the APIG dedicated instance.
    supported_features Sequence[str]
    The supported features of the APIG dedicated instance.
    vpc_ingress_address str
    The ingress private ip address of vpc.
    vpcep_service_address str
    The address (full name) of the VPC endpoint service.
    createTime String
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt String
    Time when the dedicated instance is created, in RFC-3339 format.
    egressAddress String
    The egress (nat) public ip address.
    id String
    The provider-assigned unique ID for this managed resource.
    ingressAddress String
    The ingress eip address.
    maintainEnd String
    End time of the maintenance time window, 4-hour difference between the start time and end time.
    status String
    Status of the APIG dedicated instance.
    supportedFeatures List<String>
    The supported features of the APIG dedicated instance.
    vpcIngressAddress String
    The ingress private ip address of vpc.
    vpcepServiceAddress String
    The address (full name) of the VPC endpoint service.

    Look up Existing ApigInstance Resource

    Get an existing ApigInstance 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?: ApigInstanceState, opts?: CustomResourceOptions): ApigInstance
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apig_instance_id: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        available_zones: Optional[Sequence[str]] = None,
        bandwidth_size: Optional[float] = None,
        create_time: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        edition: Optional[str] = None,
        egress_address: Optional[str] = None,
        eip_id: Optional[str] = None,
        enterprise_project_id: Optional[str] = None,
        ingress_address: Optional[str] = None,
        ipv6_enable: Optional[bool] = None,
        loadbalancer_provider: Optional[str] = None,
        maintain_begin: Optional[str] = None,
        maintain_end: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        security_group_id: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        supported_features: Optional[Sequence[str]] = None,
        tags: Optional[Mapping[str, str]] = None,
        timeouts: Optional[ApigInstanceTimeoutsArgs] = None,
        vpc_id: Optional[str] = None,
        vpc_ingress_address: Optional[str] = None,
        vpcep_service_address: Optional[str] = None,
        vpcep_service_name: Optional[str] = None) -> ApigInstance
    func GetApigInstance(ctx *Context, name string, id IDInput, state *ApigInstanceState, opts ...ResourceOption) (*ApigInstance, error)
    public static ApigInstance Get(string name, Input<string> id, ApigInstanceState? state, CustomResourceOptions? opts = null)
    public static ApigInstance get(String name, Output<String> id, ApigInstanceState state, CustomResourceOptions options)
    resources:  _:    type: flexibleengine:ApigInstance    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:
    ApigInstanceId string
    ID of the APIG dedicated instance.
    AvailabilityZones List<string>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    AvailableZones List<string>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    BandwidthSize double
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    CreateTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    CreatedAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    Description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    Edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    EgressAddress string
    The egress (nat) public ip address.
    EipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    EnterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    IngressAddress string
    The ingress eip address.
    Ipv6Enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    LoadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    MaintainBegin string
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    Name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    SecurityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    Status string
    Status of the APIG dedicated instance.
    SubnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    SupportedFeatures List<string>
    The supported features of the APIG dedicated instance.
    Tags Dictionary<string, string>
    Timeouts ApigInstanceTimeouts
    VpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    VpcIngressAddress string
    The ingress private ip address of vpc.
    VpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    VpcepServiceName string
    Name of the VPC endpoint service.
    ApigInstanceId string
    ID of the APIG dedicated instance.
    AvailabilityZones []string
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    AvailableZones []string
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    BandwidthSize float64
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    CreateTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    CreatedAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    Description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    Edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    EgressAddress string
    The egress (nat) public ip address.
    EipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    EnterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    IngressAddress string
    The ingress eip address.
    Ipv6Enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    LoadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    MaintainBegin string
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    Name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    Region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    SecurityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    Status string
    Status of the APIG dedicated instance.
    SubnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    SupportedFeatures []string
    The supported features of the APIG dedicated instance.
    Tags map[string]string
    Timeouts ApigInstanceTimeoutsArgs
    VpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    VpcIngressAddress string
    The ingress private ip address of vpc.
    VpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    VpcepServiceName string
    Name of the VPC endpoint service.
    apigInstanceId String
    ID of the APIG dedicated instance.
    availabilityZones List<String>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones List<String>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize Double
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    createTime String
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt String
    Time when the dedicated instance is created, in RFC-3339 format.
    description String
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    edition String
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    egressAddress String
    The egress (nat) public ip address.
    eipId String
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId String
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ingressAddress String
    The ingress eip address.
    ipv6Enable Boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider String

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin String
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    name String
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    securityGroupId String
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    status String
    Status of the APIG dedicated instance.
    subnetId String
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    supportedFeatures List<String>
    The supported features of the APIG dedicated instance.
    tags Map<String,String>
    timeouts ApigInstanceTimeouts
    vpcId String
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcIngressAddress String
    The ingress private ip address of vpc.
    vpcepServiceAddress String
    The address (full name) of the VPC endpoint service.
    vpcepServiceName String
    Name of the VPC endpoint service.
    apigInstanceId string
    ID of the APIG dedicated instance.
    availabilityZones string[]
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones string[]
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize number
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    createTime string
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt string
    Time when the dedicated instance is created, in RFC-3339 format.
    description string
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    edition string
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    egressAddress string
    The egress (nat) public ip address.
    eipId string
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId string
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ingressAddress string
    The ingress eip address.
    ipv6Enable boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider string

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin string
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    name string
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region string
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    securityGroupId string
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    status string
    Status of the APIG dedicated instance.
    subnetId string
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    supportedFeatures string[]
    The supported features of the APIG dedicated instance.
    tags {[key: string]: string}
    timeouts ApigInstanceTimeouts
    vpcId string
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcIngressAddress string
    The ingress private ip address of vpc.
    vpcepServiceAddress string
    The address (full name) of the VPC endpoint service.
    vpcepServiceName string
    Name of the VPC endpoint service.
    apig_instance_id str
    ID of the APIG dedicated instance.
    availability_zones Sequence[str]
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    available_zones Sequence[str]
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidth_size float
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    create_time str
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    created_at str
    Time when the dedicated instance is created, in RFC-3339 format.
    description str
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    edition str
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    egress_address str
    The egress (nat) public ip address.
    eip_id str
    Specifies the eip ID associated with the APIG dedicated instance.
    enterprise_project_id str
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ingress_address str
    The ingress eip address.
    ipv6_enable bool
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancer_provider str

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintain_begin str
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    name str
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region str
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    security_group_id str
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    status str
    Status of the APIG dedicated instance.
    subnet_id str
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    supported_features Sequence[str]
    The supported features of the APIG dedicated instance.
    tags Mapping[str, str]
    timeouts ApigInstanceTimeoutsArgs
    vpc_id str
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpc_ingress_address str
    The ingress private ip address of vpc.
    vpcep_service_address str
    The address (full name) of the VPC endpoint service.
    vpcep_service_name str
    Name of the VPC endpoint service.
    apigInstanceId String
    ID of the APIG dedicated instance.
    availabilityZones List<String>
    Specifies an array of available zone names for the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    availableZones List<String>
    schema: Deprecated; The name list of availability zones for the dedicated instance.
    bandwidthSize Number
    Specifies the egress bandwidth size of the APIG dedicated instance. The range of valid value is from 1 to 2000.
    createTime String
    schema: Deprecated; Time when the dedicated instance is created.

    Deprecated: Deprecated

    createdAt String
    Time when the dedicated instance is created, in RFC-3339 format.
    description String
    Specifies the description about the APIG dedicated instance. The description contain a maximum of 255 characters and the angle brackets (< and >) are not allowed.
    edition String
    Specifies the edition of the APIG dedicated instance. The supported editions are as follows: BASIC, PROFESSIONAL, ENTERPRISE, PLATINUM. Changing this will create a new APIG dedicated instance resource.
    egressAddress String
    The egress (nat) public ip address.
    eipId String
    Specifies the eip ID associated with the APIG dedicated instance.
    enterpriseProjectId String
    Specifies the enterprise project ID to which the dedicated instance belongs. This parameter is required for enterprise users. Changing this will create a new resource.
    ingressAddress String
    The ingress eip address.
    ipv6Enable Boolean
    Specifies whether public access with an IPv6 address is supported.
    Changing this will create a new resource.
    loadbalancerProvider String

    Specifies the provider type of load balancer used by the dedicated instance. The valid values are as follows:

    • lvs: Linux virtual server.
    • elb: Elastic load balance.

    Changing this will create a new resource.

    maintainBegin String
    Specifies a start time of the maintenance time window 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, 4-hour difference between the start time and end time.
    name String
    Specifies the name of the API dedicated instance. The API group name consists of 3 to 64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
    region String
    Specifies the region in which to create the APIG dedicated instance resource. If omitted, the provider-level region will be used. Changing this will create a new APIG dedicated instance resource.
    securityGroupId String
    Specifies the ID of the security group to which the APIG dedicated instance belongs to.
    status String
    Status of the APIG dedicated instance.
    subnetId String
    Specifies the ID of the VPC Subnet used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    supportedFeatures List<String>
    The supported features of the APIG dedicated instance.
    tags Map<String>
    timeouts Property Map
    vpcId String
    Specifies the ID of the VPC used to create the APIG dedicated instance. Changing this will create a new APIG dedicated instance resource.
    vpcIngressAddress String
    The ingress private ip address of vpc.
    vpcepServiceAddress String
    The address (full name) of the VPC endpoint service.
    vpcepServiceName String
    Name of the VPC endpoint service.

    Supporting Types

    ApigInstanceTimeouts, ApigInstanceTimeoutsArgs

    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 Dedicated Instances can be imported by their id, e.g.

    $ pulumi import flexibleengine:index/apigInstance:ApigInstance test de379eed30aa4d31a84f426ea3c7ef4e

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

    Package Details

    Repository
    flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
    License
    Notes
    This Pulumi package is based on the flexibleengine Terraform Provider.
    flexibleengine logo
    flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
    flexibleenginecloud/terraform-provider-flexibleengine