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

flexibleengine.ApigVpcChannel

Explore with Pulumi AI

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

!> WARNING: It has been deprecated.

Manages a VPC channel resource within FlexibleEngine.

Example Usage

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

const config = new pulumi.Config();
const instanceId = config.requireObject("instanceId");
const channelName = config.requireObject("channelName");
const ecsId1 = config.requireObject("ecsId1");
const ecsId2 = config.requireObject("ecsId2");
const test = new flexibleengine.ApigVpcChannel("test", {
    instanceId: instanceId,
    port: 8080,
    protocol: "HTTPS",
    path: "/",
    httpCode: "201,202,203",
    members: [
        {
            id: ecsId1,
            weight: 30,
        },
        {
            id: ecsId2,
            weight: 70,
        },
    ],
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
instance_id = config.require_object("instanceId")
channel_name = config.require_object("channelName")
ecs_id1 = config.require_object("ecsId1")
ecs_id2 = config.require_object("ecsId2")
test = flexibleengine.ApigVpcChannel("test",
    instance_id=instance_id,
    port=8080,
    protocol="HTTPS",
    path="/",
    http_code="201,202,203",
    members=[
        {
            "id": ecs_id1,
            "weight": 30,
        },
        {
            "id": ecs_id2,
            "weight": 70,
        },
    ])
Copy
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, "")
		instanceId := cfg.RequireObject("instanceId")
		channelName := cfg.RequireObject("channelName")
		ecsId1 := cfg.RequireObject("ecsId1")
		ecsId2 := cfg.RequireObject("ecsId2")
		_, err := flexibleengine.NewApigVpcChannel(ctx, "test", &flexibleengine.ApigVpcChannelArgs{
			InstanceId: pulumi.Any(instanceId),
			Port:       pulumi.Float64(8080),
			Protocol:   pulumi.String("HTTPS"),
			Path:       pulumi.String("/"),
			HttpCode:   pulumi.String("201,202,203"),
			Members: flexibleengine.ApigVpcChannelMemberArray{
				&flexibleengine.ApigVpcChannelMemberArgs{
					Id:     pulumi.Any(ecsId1),
					Weight: pulumi.Float64(30),
				},
				&flexibleengine.ApigVpcChannelMemberArgs{
					Id:     pulumi.Any(ecsId2),
					Weight: pulumi.Float64(70),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var instanceId = config.RequireObject<dynamic>("instanceId");
    var channelName = config.RequireObject<dynamic>("channelName");
    var ecsId1 = config.RequireObject<dynamic>("ecsId1");
    var ecsId2 = config.RequireObject<dynamic>("ecsId2");
    var test = new Flexibleengine.ApigVpcChannel("test", new()
    {
        InstanceId = instanceId,
        Port = 8080,
        Protocol = "HTTPS",
        Path = "/",
        HttpCode = "201,202,203",
        Members = new[]
        {
            new Flexibleengine.Inputs.ApigVpcChannelMemberArgs
            {
                Id = ecsId1,
                Weight = 30,
            },
            new Flexibleengine.Inputs.ApigVpcChannelMemberArgs
            {
                Id = ecsId2,
                Weight = 70,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.ApigVpcChannel;
import com.pulumi.flexibleengine.ApigVpcChannelArgs;
import com.pulumi.flexibleengine.inputs.ApigVpcChannelMemberArgs;
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 instanceId = config.get("instanceId");
        final var channelName = config.get("channelName");
        final var ecsId1 = config.get("ecsId1");
        final var ecsId2 = config.get("ecsId2");
        var test = new ApigVpcChannel("test", ApigVpcChannelArgs.builder()
            .instanceId(instanceId)
            .port(8080)
            .protocol("HTTPS")
            .path("/")
            .httpCode("201,202,203")
            .members(            
                ApigVpcChannelMemberArgs.builder()
                    .id(ecsId1)
                    .weight(30)
                    .build(),
                ApigVpcChannelMemberArgs.builder()
                    .id(ecsId2)
                    .weight(70)
                    .build())
            .build());

    }
}
Copy
configuration:
  instanceId:
    type: dynamic
  channelName:
    type: dynamic
  ecsId1:
    type: dynamic
  ecsId2:
    type: dynamic
resources:
  test:
    type: flexibleengine:ApigVpcChannel
    properties:
      instanceId: ${instanceId}
      port: 8080
      protocol: HTTPS
      path: /
      httpCode: 201,202,203
      members:
        - id: ${ecsId1}
          weight: 30
        - id: ${ecsId2}
          weight: 70
Copy

Create ApigVpcChannel Resource

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

Constructor syntax

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

@overload
def ApigVpcChannel(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   instance_id: Optional[str] = None,
                   port: Optional[float] = None,
                   members: Optional[Sequence[ApigVpcChannelMemberArgs]] = None,
                   member_type: Optional[str] = None,
                   http_code: Optional[str] = None,
                   interval: Optional[float] = None,
                   algorithm: Optional[str] = None,
                   healthy_threshold: Optional[float] = None,
                   name: Optional[str] = None,
                   path: Optional[str] = None,
                   apig_vpc_channel_id: Optional[str] = None,
                   protocol: Optional[str] = None,
                   region: Optional[str] = None,
                   timeout: Optional[float] = None,
                   unhealthy_threshold: Optional[float] = None)
func NewApigVpcChannel(ctx *Context, name string, args ApigVpcChannelArgs, opts ...ResourceOption) (*ApigVpcChannel, error)
public ApigVpcChannel(string name, ApigVpcChannelArgs args, CustomResourceOptions? opts = null)
public ApigVpcChannel(String name, ApigVpcChannelArgs args)
public ApigVpcChannel(String name, ApigVpcChannelArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ApigVpcChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ApigVpcChannelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ApigVpcChannelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ApigVpcChannelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ApigVpcChannelArgs
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 apigVpcChannelResource = new Flexibleengine.ApigVpcChannel("apigVpcChannelResource", new()
{
    InstanceId = "string",
    Port = 0,
    Members = new[]
    {
        new Flexibleengine.Inputs.ApigVpcChannelMemberArgs
        {
            Id = "string",
            IpAddress = "string",
            Weight = 0,
        },
    },
    MemberType = "string",
    HttpCode = "string",
    Interval = 0,
    Algorithm = "string",
    HealthyThreshold = 0,
    Name = "string",
    Path = "string",
    ApigVpcChannelId = "string",
    Protocol = "string",
    Region = "string",
    Timeout = 0,
    UnhealthyThreshold = 0,
});
Copy
example, err := flexibleengine.NewApigVpcChannel(ctx, "apigVpcChannelResource", &flexibleengine.ApigVpcChannelArgs{
	InstanceId: pulumi.String("string"),
	Port:       pulumi.Float64(0),
	Members: flexibleengine.ApigVpcChannelMemberArray{
		&flexibleengine.ApigVpcChannelMemberArgs{
			Id:        pulumi.String("string"),
			IpAddress: pulumi.String("string"),
			Weight:    pulumi.Float64(0),
		},
	},
	MemberType:         pulumi.String("string"),
	HttpCode:           pulumi.String("string"),
	Interval:           pulumi.Float64(0),
	Algorithm:          pulumi.String("string"),
	HealthyThreshold:   pulumi.Float64(0),
	Name:               pulumi.String("string"),
	Path:               pulumi.String("string"),
	ApigVpcChannelId:   pulumi.String("string"),
	Protocol:           pulumi.String("string"),
	Region:             pulumi.String("string"),
	Timeout:            pulumi.Float64(0),
	UnhealthyThreshold: pulumi.Float64(0),
})
Copy
var apigVpcChannelResource = new ApigVpcChannel("apigVpcChannelResource", ApigVpcChannelArgs.builder()
    .instanceId("string")
    .port(0)
    .members(ApigVpcChannelMemberArgs.builder()
        .id("string")
        .ipAddress("string")
        .weight(0)
        .build())
    .memberType("string")
    .httpCode("string")
    .interval(0)
    .algorithm("string")
    .healthyThreshold(0)
    .name("string")
    .path("string")
    .apigVpcChannelId("string")
    .protocol("string")
    .region("string")
    .timeout(0)
    .unhealthyThreshold(0)
    .build());
Copy
apig_vpc_channel_resource = flexibleengine.ApigVpcChannel("apigVpcChannelResource",
    instance_id="string",
    port=0,
    members=[{
        "id": "string",
        "ip_address": "string",
        "weight": 0,
    }],
    member_type="string",
    http_code="string",
    interval=0,
    algorithm="string",
    healthy_threshold=0,
    name="string",
    path="string",
    apig_vpc_channel_id="string",
    protocol="string",
    region="string",
    timeout=0,
    unhealthy_threshold=0)
Copy
const apigVpcChannelResource = new flexibleengine.ApigVpcChannel("apigVpcChannelResource", {
    instanceId: "string",
    port: 0,
    members: [{
        id: "string",
        ipAddress: "string",
        weight: 0,
    }],
    memberType: "string",
    httpCode: "string",
    interval: 0,
    algorithm: "string",
    healthyThreshold: 0,
    name: "string",
    path: "string",
    apigVpcChannelId: "string",
    protocol: "string",
    region: "string",
    timeout: 0,
    unhealthyThreshold: 0,
});
Copy
type: flexibleengine:ApigVpcChannel
properties:
    algorithm: string
    apigVpcChannelId: string
    healthyThreshold: 0
    httpCode: string
    instanceId: string
    interval: 0
    memberType: string
    members:
        - id: string
          ipAddress: string
          weight: 0
    name: string
    path: string
    port: 0
    protocol: string
    region: string
    timeout: 0
    unhealthyThreshold: 0
Copy

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

InstanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
Members This property is required. List<ApigVpcChannelMember>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
Port This property is required. double
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
Algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
ApigVpcChannelId string
ID of the VPC channel.
HealthyThreshold double
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
HttpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

Interval double
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
MemberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
Name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
Path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
Protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
Region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
Timeout double
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
UnhealthyThreshold double
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
InstanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
Members This property is required. []ApigVpcChannelMemberArgs
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
Port This property is required. float64
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
Algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
ApigVpcChannelId string
ID of the VPC channel.
HealthyThreshold float64
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
HttpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

Interval float64
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
MemberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
Name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
Path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
Protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
Region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
Timeout float64
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
UnhealthyThreshold float64
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
instanceId This property is required. String
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
members This property is required. List<ApigVpcChannelMember>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
port This property is required. Double
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
algorithm String
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId String
ID of the VPC channel.
healthyThreshold Double
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode String

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

interval Double
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType String
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
name String
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path String
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
protocol String
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region String
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
timeout Double
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold Double
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
instanceId This property is required. string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
members This property is required. ApigVpcChannelMember[]
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
port This property is required. number
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId string
ID of the VPC channel.
healthyThreshold number
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

interval number
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
timeout number
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold number
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
instance_id This property is required. str
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
members This property is required. Sequence[ApigVpcChannelMemberArgs]
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
port This property is required. float
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
algorithm str
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apig_vpc_channel_id str
ID of the VPC channel.
healthy_threshold float
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
http_code str

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

interval float
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
member_type str
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
name str
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path str
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
protocol str
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region str
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
timeout float
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthy_threshold float
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
instanceId This property is required. String
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
members This property is required. List<Property Map>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
port This property is required. Number
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
algorithm String
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId String
ID of the VPC channel.
healthyThreshold Number
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode String

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

interval Number
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType String
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
name String
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path String
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
protocol String
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region String
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
timeout Number
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold Number
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.

Outputs

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

CreatedAt string
The time when the VPC channel was created.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of VPC channel, supports Normal and Abnormal.
CreatedAt string
The time when the VPC channel was created.
Id string
The provider-assigned unique ID for this managed resource.
Status string
The status of VPC channel, supports Normal and Abnormal.
createdAt String
The time when the VPC channel was created.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of VPC channel, supports Normal and Abnormal.
createdAt string
The time when the VPC channel was created.
id string
The provider-assigned unique ID for this managed resource.
status string
The status of VPC channel, supports Normal and Abnormal.
created_at str
The time when the VPC channel was created.
id str
The provider-assigned unique ID for this managed resource.
status str
The status of VPC channel, supports Normal and Abnormal.
createdAt String
The time when the VPC channel was created.
id String
The provider-assigned unique ID for this managed resource.
status String
The status of VPC channel, supports Normal and Abnormal.

Look up Existing ApigVpcChannel Resource

Get an existing ApigVpcChannel 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?: ApigVpcChannelState, opts?: CustomResourceOptions): ApigVpcChannel
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        apig_vpc_channel_id: Optional[str] = None,
        created_at: Optional[str] = None,
        healthy_threshold: Optional[float] = None,
        http_code: Optional[str] = None,
        instance_id: Optional[str] = None,
        interval: Optional[float] = None,
        member_type: Optional[str] = None,
        members: Optional[Sequence[ApigVpcChannelMemberArgs]] = None,
        name: Optional[str] = None,
        path: Optional[str] = None,
        port: Optional[float] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        timeout: Optional[float] = None,
        unhealthy_threshold: Optional[float] = None) -> ApigVpcChannel
func GetApigVpcChannel(ctx *Context, name string, id IDInput, state *ApigVpcChannelState, opts ...ResourceOption) (*ApigVpcChannel, error)
public static ApigVpcChannel Get(string name, Input<string> id, ApigVpcChannelState? state, CustomResourceOptions? opts = null)
public static ApigVpcChannel get(String name, Output<String> id, ApigVpcChannelState state, CustomResourceOptions options)
resources:  _:    type: flexibleengine:ApigVpcChannel    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
ApigVpcChannelId string
ID of the VPC channel.
CreatedAt string
The time when the VPC channel was created.
HealthyThreshold double
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
HttpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

InstanceId string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
Interval double
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
MemberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
Members List<ApigVpcChannelMember>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
Name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
Path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
Port double
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
Protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
Region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
Status string
The status of VPC channel, supports Normal and Abnormal.
Timeout double
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
UnhealthyThreshold double
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
Algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
ApigVpcChannelId string
ID of the VPC channel.
CreatedAt string
The time when the VPC channel was created.
HealthyThreshold float64
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
HttpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

InstanceId string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
Interval float64
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
MemberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
Members []ApigVpcChannelMemberArgs
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
Name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
Path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
Port float64
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
Protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
Region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
Status string
The status of VPC channel, supports Normal and Abnormal.
Timeout float64
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
UnhealthyThreshold float64
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
algorithm String
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId String
ID of the VPC channel.
createdAt String
The time when the VPC channel was created.
healthyThreshold Double
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode String

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

instanceId String
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
interval Double
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType String
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
members List<ApigVpcChannelMember>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
name String
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path String
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
port Double
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
protocol String
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region String
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
status String
The status of VPC channel, supports Normal and Abnormal.
timeout Double
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold Double
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
algorithm string
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId string
ID of the VPC channel.
createdAt string
The time when the VPC channel was created.
healthyThreshold number
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode string

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

instanceId string
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
interval number
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType string
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
members ApigVpcChannelMember[]
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
name string
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path string
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
port number
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
protocol string
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region string
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
status string
The status of VPC channel, supports Normal and Abnormal.
timeout number
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold number
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
algorithm str
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apig_vpc_channel_id str
ID of the VPC channel.
created_at str
The time when the VPC channel was created.
healthy_threshold float
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
http_code str

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

instance_id str
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
interval float
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
member_type str
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
members Sequence[ApigVpcChannelMemberArgs]
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
name str
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path str
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
port float
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
protocol str
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region str
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
status str
The status of VPC channel, supports Normal and Abnormal.
timeout float
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthy_threshold float
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.
algorithm String
Specifies the type of the backend service. The valid types are WRR, WLC, SH and URI hashing, default to WRR.
apigVpcChannelId String
ID of the VPC channel.
createdAt String
The time when the VPC channel was created.
healthyThreshold Number
Specifies the healthy threshold, which refers to the number of consecutive successful checks required for a backend server to be considered healthy. The valid value is range from 2 to 10, default to 2.
httpCode String

Specifies the response codes for determining a successful HTTP response.
The valid value ranges from 100 to 599 and the valid formats are as follows:

  • The multiple values, for example, 200,201,202.
  • The range, for example, 200-299.
  • Both multiple values and ranges, for example, 201,202,210-299.

It is Required if the protocol is HTTP.

instanceId String
Specifies an ID of the APIG dedicated instance to which the APIG vpc channel belongs to. Changing this will create a new VPC channel resource.
interval Number
Specifies the interval between consecutive checks, in second. The valid value is range from 5 to 300, default to 10.
memberType String
Specifies the type of the backend service. The valid types are ECS and EIP, default to ECS.
members List<Property Map>
Specifies an array of one or more backend server IDs or IP addresses that bind the VPC channel. The object structure is documented below.
name String
Specifies the name of the VPC channel. The channel name consists of 3 to 64 characters, starting with a letter. Only letters, digits and underscores (_) are allowed. Chinese characters must be in UTF-8 or Unicode format.
path String
Specifies the destination path for health checks. Required if protocol is HTTP or HTTPS.
port Number
Specifies the host port of the VPC channel. The valid value is range from 1 to 65535.
protocol String
Specifies the protocol for performing health checks on backend servers in the VPC channel. The valid values are TCP, HTTP and HTTPS, default to TCP.
region String
Specifies the region in which to create the VPC channel resource. If omitted, the provider-level region will be used. Changing this will create a new VPC channel resource.
status String
The status of VPC channel, supports Normal and Abnormal.
timeout Number
Specifies the timeout for determining whether a health check fails, in second. The value must be less than the value of time_interval. The valid value is range from 2 to 30, default to 5.
unhealthyThreshold Number
Specifies the unhealthy threshold, which refers to the number of consecutive failed checks required for a backend server to be considered unhealthy. The valid value is range from 2 to 10, default to 5.

Supporting Types

ApigVpcChannelMember
, ApigVpcChannelMemberArgs

Id string
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
IpAddress string
Specifies the IP address each backend servers. Required if member_type is EIP.
Weight double
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.
Id string
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
IpAddress string
Specifies the IP address each backend servers. Required if member_type is EIP.
Weight float64
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.
id String
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
ipAddress String
Specifies the IP address each backend servers. Required if member_type is EIP.
weight Double
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.
id string
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
ipAddress string
Specifies the IP address each backend servers. Required if member_type is EIP.
weight number
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.
id str
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
ip_address str
Specifies the IP address each backend servers. Required if member_type is EIP.
weight float
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.
id String
Specifies the ECS ID for each backend servers. Required if member_type is ECS. This parameter and ip_address are alternative.
ipAddress String
Specifies the IP address each backend servers. Required if member_type is EIP.
weight Number
Specifies the backend server weight. The valid values are range from 1 to 100, default to 1.

Import

VPC Channels can be imported using the ID of the APIG dedicated instance to which the channel

belongs and name, separated by a slash, e.g.

$ pulumi import flexibleengine:index/apigVpcChannel:ApigVpcChannel test <instance_id>/<name>
Copy

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 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine