Alibaba Cloud v3.76.0, Apr 8 25

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.apigateway.Instance

Explore with Pulumi AI

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

Example Usage

Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const _default = new alicloud.apigateway.Instance("default", {
    instanceName: name,
    instanceSpec: "api.s1.small",
    httpsPolicy: "HTTPS2_TLS1_0",
    zoneId: "cn-hangzhou-MAZ6(i,j,k)",
    paymentType: "PayAsYouGo",
    instanceType: "normal",
});

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.apigateway.Instance("default",
    instance_name=name,
    instance_spec="api.s1.small",
    https_policy="HTTPS2_TLS1_0",
    zone_id="cn-hangzhou-MAZ6(i,j,k)",
    payment_type="PayAsYouGo",
    instance_type="normal")

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := apigateway.NewInstance(ctx, "default", &apigateway.InstanceArgs{
			InstanceName: pulumi.String(name),
			InstanceSpec: pulumi.String("api.s1.small"),
			HttpsPolicy:  pulumi.String("HTTPS2_TLS1_0"),
			ZoneId:       pulumi.String("cn-hangzhou-MAZ6(i,j,k)"),
			PaymentType:  pulumi.String("PayAsYouGo"),
			InstanceType: pulumi.String("normal"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var @default = new AliCloud.ApiGateway.Instance("default", new()
    {
        InstanceName = name,
        InstanceSpec = "api.s1.small",
        HttpsPolicy = "HTTPS2_TLS1_0",
        ZoneId = "cn-hangzhou-MAZ6(i,j,k)",
        PaymentType = "PayAsYouGo",
        InstanceType = "normal",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.Instance;
import com.pulumi.alicloud.apigateway.InstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var default_ = new Instance("default", InstanceArgs.builder()
            .instanceName(name)
            .instanceSpec("api.s1.small")
            .httpsPolicy("HTTPS2_TLS1_0")
            .zoneId("cn-hangzhou-MAZ6(i,j,k)")
            .paymentType("PayAsYouGo")
            .instanceType("normal")
            .build());

    }
}

configuration:
  name:
    type: string
    default: terraform-example
resources:
  default:
    type: alicloud:apigateway:Instance
    properties:
      instanceName: ${name}
      instanceSpec: api.s1.small
      httpsPolicy: HTTPS2_TLS1_0
      zoneId: cn-hangzhou-MAZ6(i,j,k)
      paymentType: PayAsYouGo
      instanceType: normal

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const vpc = new alicloud.vpc.Network("vpc", {
    cidrBlock: "172.16.0.0/12",
    vpcName: name,
});
const vswitch1 = new alicloud.vpc.Switch("vswitch_1", {
    vpcId: vpc.id,
    cidrBlock: "172.16.0.0/16",
    zoneId: "cn-hangzhou-j",
    vswitchName: `${name}_1`,
});
const vswitch2 = new alicloud.vpc.Switch("vswitch_2", {
    vpcId: vpc.id,
    cidrBlock: "172.17.0.0/16",
    zoneId: "cn-hangzhou-k",
    vswitchName: `${name}_2`,
});
const securityGroup = new alicloud.ecs.SecurityGroup("security_group", {
    vpcId: vpc.id,
    securityGroupName: name,
});
const vpcIntegrationInstance = new alicloud.apigateway.Instance("vpc_integration_instance", {
    instanceName: name,
    httpsPolicy: "HTTPS2_TLS1_0",
    instanceSpec: "api.s1.small",
    instanceType: "vpc_connect",
    paymentType: "PayAsYouGo",
    userVpcId: vpc.id,
    instanceCidr: "192.168.0.0/16",
    zoneVswitchSecurityGroups: [
        {
            zoneId: vswitch1.zoneId,
            vswitchId: vswitch1.id,
            cidrBlock: vswitch1.cidrBlock,
            securityGroup: securityGroup.id,
        },
        {
            zoneId: vswitch2.zoneId,
            vswitchId: vswitch2.id,
            cidrBlock: vswitch2.cidrBlock,
            securityGroup: securityGroup.id,
        },
    ],
});

import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
vpc = alicloud.vpc.Network("vpc",
    cidr_block="172.16.0.0/12",
    vpc_name=name)
vswitch1 = alicloud.vpc.Switch("vswitch_1",
    vpc_id=vpc.id,
    cidr_block="172.16.0.0/16",
    zone_id="cn-hangzhou-j",
    vswitch_name=f"{name}_1")
vswitch2 = alicloud.vpc.Switch("vswitch_2",
    vpc_id=vpc.id,
    cidr_block="172.17.0.0/16",
    zone_id="cn-hangzhou-k",
    vswitch_name=f"{name}_2")
security_group = alicloud.ecs.SecurityGroup("security_group",
    vpc_id=vpc.id,
    security_group_name=name)
vpc_integration_instance = alicloud.apigateway.Instance("vpc_integration_instance",
    instance_name=name,
    https_policy="HTTPS2_TLS1_0",
    instance_spec="api.s1.small",
    instance_type="vpc_connect",
    payment_type="PayAsYouGo",
    user_vpc_id=vpc.id,
    instance_cidr="192.168.0.0/16",
    zone_vswitch_security_groups=[
        {
            "zone_id": vswitch1.zone_id,
            "vswitch_id": vswitch1.id,
            "cidr_block": vswitch1.cidr_block,
            "security_group": security_group.id,
        },
        {
            "zone_id": vswitch2.zone_id,
            "vswitch_id": vswitch2.id,
            "cidr_block": vswitch2.cidr_block,
            "security_group": security_group.id,
        },
    ])

package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/apigateway"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		vpc, err := vpc.NewNetwork(ctx, "vpc", &vpc.NetworkArgs{
			CidrBlock: pulumi.String("172.16.0.0/12"),
			VpcName:   pulumi.String(name),
		})
		if err != nil {
			return err
		}
		vswitch1, err := vpc.NewSwitch(ctx, "vswitch_1", &vpc.SwitchArgs{
			VpcId:       vpc.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/16"),
			ZoneId:      pulumi.String("cn-hangzhou-j"),
			VswitchName: pulumi.Sprintf("%v_1", name),
		})
		if err != nil {
			return err
		}
		vswitch2, err := vpc.NewSwitch(ctx, "vswitch_2", &vpc.SwitchArgs{
			VpcId:       vpc.ID(),
			CidrBlock:   pulumi.String("172.17.0.0/16"),
			ZoneId:      pulumi.String("cn-hangzhou-k"),
			VswitchName: pulumi.Sprintf("%v_2", name),
		})
		if err != nil {
			return err
		}
		securityGroup, err := ecs.NewSecurityGroup(ctx, "security_group", &ecs.SecurityGroupArgs{
			VpcId:             vpc.ID(),
			SecurityGroupName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = apigateway.NewInstance(ctx, "vpc_integration_instance", &apigateway.InstanceArgs{
			InstanceName: pulumi.String(name),
			HttpsPolicy:  pulumi.String("HTTPS2_TLS1_0"),
			InstanceSpec: pulumi.String("api.s1.small"),
			InstanceType: pulumi.String("vpc_connect"),
			PaymentType:  pulumi.String("PayAsYouGo"),
			UserVpcId:    vpc.ID(),
			InstanceCidr: pulumi.String("192.168.0.0/16"),
			ZoneVswitchSecurityGroups: apigateway.InstanceZoneVswitchSecurityGroupArray{
				&apigateway.InstanceZoneVswitchSecurityGroupArgs{
					ZoneId:        vswitch1.ZoneId,
					VswitchId:     vswitch1.ID(),
					CidrBlock:     vswitch1.CidrBlock,
					SecurityGroup: securityGroup.ID(),
				},
				&apigateway.InstanceZoneVswitchSecurityGroupArgs{
					ZoneId:        vswitch2.ZoneId,
					VswitchId:     vswitch2.ID(),
					CidrBlock:     vswitch2.CidrBlock,
					SecurityGroup: securityGroup.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var vpc = new AliCloud.Vpc.Network("vpc", new()
    {
        CidrBlock = "172.16.0.0/12",
        VpcName = name,
    });

    var vswitch1 = new AliCloud.Vpc.Switch("vswitch_1", new()
    {
        VpcId = vpc.Id,
        CidrBlock = "172.16.0.0/16",
        ZoneId = "cn-hangzhou-j",
        VswitchName = $"{name}_1",
    });

    var vswitch2 = new AliCloud.Vpc.Switch("vswitch_2", new()
    {
        VpcId = vpc.Id,
        CidrBlock = "172.17.0.0/16",
        ZoneId = "cn-hangzhou-k",
        VswitchName = $"{name}_2",
    });

    var securityGroup = new AliCloud.Ecs.SecurityGroup("security_group", new()
    {
        VpcId = vpc.Id,
        SecurityGroupName = name,
    });

    var vpcIntegrationInstance = new AliCloud.ApiGateway.Instance("vpc_integration_instance", new()
    {
        InstanceName = name,
        HttpsPolicy = "HTTPS2_TLS1_0",
        InstanceSpec = "api.s1.small",
        InstanceType = "vpc_connect",
        PaymentType = "PayAsYouGo",
        UserVpcId = vpc.Id,
        InstanceCidr = "192.168.0.0/16",
        ZoneVswitchSecurityGroups = new[]
        {
            new AliCloud.ApiGateway.Inputs.InstanceZoneVswitchSecurityGroupArgs
            {
                ZoneId = vswitch1.ZoneId,
                VswitchId = vswitch1.Id,
                CidrBlock = vswitch1.CidrBlock,
                SecurityGroup = securityGroup.Id,
            },
            new AliCloud.ApiGateway.Inputs.InstanceZoneVswitchSecurityGroupArgs
            {
                ZoneId = vswitch2.ZoneId,
                VswitchId = vswitch2.Id,
                CidrBlock = vswitch2.CidrBlock,
                SecurityGroup = securityGroup.Id,
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.apigateway.Instance;
import com.pulumi.alicloud.apigateway.InstanceArgs;
import com.pulumi.alicloud.apigateway.inputs.InstanceZoneVswitchSecurityGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var vpc = new Network("vpc", NetworkArgs.builder()
            .cidrBlock("172.16.0.0/12")
            .vpcName(name)
            .build());

        var vswitch1 = new Switch("vswitch1", SwitchArgs.builder()
            .vpcId(vpc.id())
            .cidrBlock("172.16.0.0/16")
            .zoneId("cn-hangzhou-j")
            .vswitchName(String.format("%s_1", name))
            .build());

        var vswitch2 = new Switch("vswitch2", SwitchArgs.builder()
            .vpcId(vpc.id())
            .cidrBlock("172.17.0.0/16")
            .zoneId("cn-hangzhou-k")
            .vswitchName(String.format("%s_2", name))
            .build());

        var securityGroup = new SecurityGroup("securityGroup", SecurityGroupArgs.builder()
            .vpcId(vpc.id())
            .securityGroupName(name)
            .build());

        var vpcIntegrationInstance = new Instance("vpcIntegrationInstance", InstanceArgs.builder()
            .instanceName(name)
            .httpsPolicy("HTTPS2_TLS1_0")
            .instanceSpec("api.s1.small")
            .instanceType("vpc_connect")
            .paymentType("PayAsYouGo")
            .userVpcId(vpc.id())
            .instanceCidr("192.168.0.0/16")
            .zoneVswitchSecurityGroups(            
                InstanceZoneVswitchSecurityGroupArgs.builder()
                    .zoneId(vswitch1.zoneId())
                    .vswitchId(vswitch1.id())
                    .cidrBlock(vswitch1.cidrBlock())
                    .securityGroup(securityGroup.id())
                    .build(),
                InstanceZoneVswitchSecurityGroupArgs.builder()
                    .zoneId(vswitch2.zoneId())
                    .vswitchId(vswitch2.id())
                    .cidrBlock(vswitch2.cidrBlock())
                    .securityGroup(securityGroup.id())
                    .build())
            .build());

    }
}

configuration:
  name:
    type: string
    default: terraform-example
resources:
  vpc:
    type: alicloud:vpc:Network
    properties:
      cidrBlock: 172.16.0.0/12
      vpcName: ${name}
  vswitch1:
    type: alicloud:vpc:Switch
    name: vswitch_1
    properties:
      vpcId: ${vpc.id}
      cidrBlock: 172.16.0.0/16
      zoneId: cn-hangzhou-j
      vswitchName: ${name}_1
  vswitch2:
    type: alicloud:vpc:Switch
    name: vswitch_2
    properties:
      vpcId: ${vpc.id}
      cidrBlock: 172.17.0.0/16
      zoneId: cn-hangzhou-k
      vswitchName: ${name}_2
  securityGroup:
    type: alicloud:ecs:SecurityGroup
    name: security_group
    properties:
      vpcId: ${vpc.id}
      securityGroupName: ${name}
  vpcIntegrationInstance:
    type: alicloud:apigateway:Instance
    name: vpc_integration_instance
    properties:
      instanceName: ${name}
      httpsPolicy: HTTPS2_TLS1_0
      instanceSpec: api.s1.small
      instanceType: vpc_connect
      paymentType: PayAsYouGo
      userVpcId: ${vpc.id}
      instanceCidr: 192.168.0.0/16
      zoneVswitchSecurityGroups:
        - zoneId: ${vswitch1.zoneId}
          vswitchId: ${vswitch1.id}
          cidrBlock: ${vswitch1.cidrBlock}
          securityGroup: ${securityGroup.id}
        - zoneId: ${vswitch2.zoneId}
          vswitchId: ${vswitch2.id}
          cidrBlock: ${vswitch2.cidrBlock}
          securityGroup: ${securityGroup.id}

Create Instance Resource

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

Constructor syntax

new Instance(name: string, args: InstanceArgs, opts?: CustomResourceOptions);

@overload
def Instance(resource_name: str,
             args: InstanceArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             instance_name: Optional[str] = None,
             payment_type: Optional[str] = None,
             instance_spec: Optional[str] = None,
             https_policy: Optional[str] = None,
             instance_type: Optional[str] = None,
             ipv6_enabled: Optional[bool] = None,
             ingress_vswitch_id: Optional[str] = None,
             instance_cidr: Optional[str] = None,
             ingress_vpc_id: Optional[str] = None,
             egress_ipv6_enable: Optional[bool] = None,
             delete_vpc_ip_block: Optional[str] = None,
             ingress_vpc_owner_id: Optional[str] = None,
             duration: Optional[int] = None,
             pricing_cycle: Optional[str] = None,
             skip_wait_switch: Optional[bool] = None,
             to_connect_vpc_ip_block: Optional[InstanceToConnectVpcIpBlockArgs] = None,
             user_vpc_id: Optional[str] = None,
             vpc_slb_intranet_enable: Optional[bool] = None,
             zone_id: Optional[str] = None,
             zone_vswitch_security_groups: Optional[Sequence[InstanceZoneVswitchSecurityGroupArgs]] = None)

func NewInstance(ctx *Context, name string, args InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs args, CustomResourceOptions? opts = null)

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

type: alicloud:apigateway:Instance
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 InstanceArgs: 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 InstanceArgs: 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 InstanceArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args InstanceArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args InstanceArgs: 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 exampleinstanceResourceResourceFromApigatewayinstance = new AliCloud.ApiGateway.Instance("exampleinstanceResourceResourceFromApigatewayinstance", new()
{
    InstanceName = "string",
    PaymentType = "string",
    InstanceSpec = "string",
    HttpsPolicy = "string",
    InstanceType = "string",
    Ipv6Enabled = false,
    IngressVswitchId = "string",
    InstanceCidr = "string",
    IngressVpcId = "string",
    EgressIpv6Enable = false,
    DeleteVpcIpBlock = "string",
    IngressVpcOwnerId = "string",
    Duration = 0,
    PricingCycle = "string",
    SkipWaitSwitch = false,
    ToConnectVpcIpBlock = new AliCloud.ApiGateway.Inputs.InstanceToConnectVpcIpBlockArgs
    {
        CidrBlock = "string",
        Customized = false,
        VswitchId = "string",
        ZoneId = "string",
    },
    UserVpcId = "string",
    VpcSlbIntranetEnable = false,
    ZoneId = "string",
    ZoneVswitchSecurityGroups = new[]
    {
        new AliCloud.ApiGateway.Inputs.InstanceZoneVswitchSecurityGroupArgs
        {
            CidrBlock = "string",
            SecurityGroup = "string",
            VswitchId = "string",
            ZoneId = "string",
        },
    },
});

example, err := apigateway.NewInstance(ctx, "exampleinstanceResourceResourceFromApigatewayinstance", &apigateway.InstanceArgs{
	InstanceName:      pulumi.String("string"),
	PaymentType:       pulumi.String("string"),
	InstanceSpec:      pulumi.String("string"),
	HttpsPolicy:       pulumi.String("string"),
	InstanceType:      pulumi.String("string"),
	Ipv6Enabled:       pulumi.Bool(false),
	IngressVswitchId:  pulumi.String("string"),
	InstanceCidr:      pulumi.String("string"),
	IngressVpcId:      pulumi.String("string"),
	EgressIpv6Enable:  pulumi.Bool(false),
	DeleteVpcIpBlock:  pulumi.String("string"),
	IngressVpcOwnerId: pulumi.String("string"),
	Duration:          pulumi.Int(0),
	PricingCycle:      pulumi.String("string"),
	SkipWaitSwitch:    pulumi.Bool(false),
	ToConnectVpcIpBlock: &apigateway.InstanceToConnectVpcIpBlockArgs{
		CidrBlock:  pulumi.String("string"),
		Customized: pulumi.Bool(false),
		VswitchId:  pulumi.String("string"),
		ZoneId:     pulumi.String("string"),
	},
	UserVpcId:            pulumi.String("string"),
	VpcSlbIntranetEnable: pulumi.Bool(false),
	ZoneId:               pulumi.String("string"),
	ZoneVswitchSecurityGroups: apigateway.InstanceZoneVswitchSecurityGroupArray{
		&apigateway.InstanceZoneVswitchSecurityGroupArgs{
			CidrBlock:     pulumi.String("string"),
			SecurityGroup: pulumi.String("string"),
			VswitchId:     pulumi.String("string"),
			ZoneId:        pulumi.String("string"),
		},
	},
})

var exampleinstanceResourceResourceFromApigatewayinstance = new Instance("exampleinstanceResourceResourceFromApigatewayinstance", InstanceArgs.builder()
    .instanceName("string")
    .paymentType("string")
    .instanceSpec("string")
    .httpsPolicy("string")
    .instanceType("string")
    .ipv6Enabled(false)
    .ingressVswitchId("string")
    .instanceCidr("string")
    .ingressVpcId("string")
    .egressIpv6Enable(false)
    .deleteVpcIpBlock("string")
    .ingressVpcOwnerId("string")
    .duration(0)
    .pricingCycle("string")
    .skipWaitSwitch(false)
    .toConnectVpcIpBlock(InstanceToConnectVpcIpBlockArgs.builder()
        .cidrBlock("string")
        .customized(false)
        .vswitchId("string")
        .zoneId("string")
        .build())
    .userVpcId("string")
    .vpcSlbIntranetEnable(false)
    .zoneId("string")
    .zoneVswitchSecurityGroups(InstanceZoneVswitchSecurityGroupArgs.builder()
        .cidrBlock("string")
        .securityGroup("string")
        .vswitchId("string")
        .zoneId("string")
        .build())
    .build());

exampleinstance_resource_resource_from_apigatewayinstance = alicloud.apigateway.Instance("exampleinstanceResourceResourceFromApigatewayinstance",
    instance_name="string",
    payment_type="string",
    instance_spec="string",
    https_policy="string",
    instance_type="string",
    ipv6_enabled=False,
    ingress_vswitch_id="string",
    instance_cidr="string",
    ingress_vpc_id="string",
    egress_ipv6_enable=False,
    delete_vpc_ip_block="string",
    ingress_vpc_owner_id="string",
    duration=0,
    pricing_cycle="string",
    skip_wait_switch=False,
    to_connect_vpc_ip_block={
        "cidr_block": "string",
        "customized": False,
        "vswitch_id": "string",
        "zone_id": "string",
    },
    user_vpc_id="string",
    vpc_slb_intranet_enable=False,
    zone_id="string",
    zone_vswitch_security_groups=[{
        "cidr_block": "string",
        "security_group": "string",
        "vswitch_id": "string",
        "zone_id": "string",
    }])

const exampleinstanceResourceResourceFromApigatewayinstance = new alicloud.apigateway.Instance("exampleinstanceResourceResourceFromApigatewayinstance", {
    instanceName: "string",
    paymentType: "string",
    instanceSpec: "string",
    httpsPolicy: "string",
    instanceType: "string",
    ipv6Enabled: false,
    ingressVswitchId: "string",
    instanceCidr: "string",
    ingressVpcId: "string",
    egressIpv6Enable: false,
    deleteVpcIpBlock: "string",
    ingressVpcOwnerId: "string",
    duration: 0,
    pricingCycle: "string",
    skipWaitSwitch: false,
    toConnectVpcIpBlock: {
        cidrBlock: "string",
        customized: false,
        vswitchId: "string",
        zoneId: "string",
    },
    userVpcId: "string",
    vpcSlbIntranetEnable: false,
    zoneId: "string",
    zoneVswitchSecurityGroups: [{
        cidrBlock: "string",
        securityGroup: "string",
        vswitchId: "string",
        zoneId: "string",
    }],
});

type: alicloud:apigateway:Instance
properties:
    deleteVpcIpBlock: string
    duration: 0
    egressIpv6Enable: false
    httpsPolicy: string
    ingressVpcId: string
    ingressVpcOwnerId: string
    ingressVswitchId: string
    instanceCidr: string
    instanceName: string
    instanceSpec: string
    instanceType: string
    ipv6Enabled: false
    paymentType: string
    pricingCycle: string
    skipWaitSwitch: false
    toConnectVpcIpBlock:
        cidrBlock: string
        customized: false
        vswitchId: string
        zoneId: string
    userVpcId: string
    vpcSlbIntranetEnable: false
    zoneId: string
    zoneVswitchSecurityGroups:
        - cidrBlock: string
          securityGroup: string
          vswitchId: string
          zoneId: string

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

HttpsPolicy string

Https policy.

InstanceName string

Instance name.

InstanceSpec string

Instance spec.

PaymentType string

The payment type of the resource.

DeleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

Duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

EgressIpv6Enable bool

Specifies whether IPv6 egress capability is enabled.

IngressVpcId string

The VpcID which the client at.

IngressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

IngressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

InstanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

InstanceType string

The type of the instance. Valid values are:

Ipv6Enabled bool

Specifies whether IPv6 ingress capability is enabled.

PricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

SkipWaitSwitch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

ToConnectVpcIpBlock Pulumi.AliCloud.ApiGateway.Inputs.InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

UserVpcId string

User's VpcID.

VpcSlbIntranetEnable bool

Whether the slb of the Vpc supports.

ZoneId string

The zone where the instance is deployed.

ZoneVswitchSecurityGroups List<Pulumi.AliCloud.ApiGateway.Inputs.InstanceZoneVswitchSecurityGroup>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

HttpsPolicy string

Https policy.

InstanceName string

Instance name.

InstanceSpec string

Instance spec.

PaymentType string

The payment type of the resource.

DeleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

Duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

EgressIpv6Enable bool

Specifies whether IPv6 egress capability is enabled.

IngressVpcId string

The VpcID which the client at.

IngressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

IngressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

InstanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

InstanceType string

The type of the instance. Valid values are:

Ipv6Enabled bool

Specifies whether IPv6 ingress capability is enabled.

PricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

SkipWaitSwitch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

ToConnectVpcIpBlock InstanceToConnectVpcIpBlockArgs

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

UserVpcId string

User's VpcID.

VpcSlbIntranetEnable bool

Whether the slb of the Vpc supports.

ZoneId string

The zone where the instance is deployed.

ZoneVswitchSecurityGroups []InstanceZoneVswitchSecurityGroupArgs

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

httpsPolicy String

Https policy.

instanceName String

Instance name.

instanceSpec String

Instance spec.

paymentType String

The payment type of the resource.

deleteVpcIpBlock String

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration Integer

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable Boolean

Specifies whether IPv6 egress capability is enabled.

ingressVpcId String

The VpcID which the client at.

ingressVpcOwnerId String

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId String

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr String

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceType String

The type of the instance. Valid values are:

ipv6Enabled Boolean

Specifies whether IPv6 ingress capability is enabled.

pricingCycle String

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch Boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

toConnectVpcIpBlock InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId String

User's VpcID.

vpcSlbIntranetEnable Boolean

Whether the slb of the Vpc supports.

zoneId String

The zone where the instance is deployed.

zoneVswitchSecurityGroups List<InstanceZoneVswitchSecurityGroup>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

httpsPolicy string

Https policy.

instanceName string

Instance name.

instanceSpec string

Instance spec.

paymentType string

The payment type of the resource.

deleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration number

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable boolean

Specifies whether IPv6 egress capability is enabled.

ingressVpcId string

The VpcID which the client at.

ingressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceType string

The type of the instance. Valid values are:

ipv6Enabled boolean

Specifies whether IPv6 ingress capability is enabled.

pricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

toConnectVpcIpBlock InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId string

User's VpcID.

vpcSlbIntranetEnable boolean

Whether the slb of the Vpc supports.

zoneId string

The zone where the instance is deployed.

zoneVswitchSecurityGroups InstanceZoneVswitchSecurityGroup[]

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

https_policy str

Https policy.

instance_name str

Instance name.

instance_spec str

Instance spec.

payment_type str

The payment type of the resource.

delete_vpc_ip_block str

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egress_ipv6_enable bool

Specifies whether IPv6 egress capability is enabled.

ingress_vpc_id str

The VpcID which the client at.

ingress_vpc_owner_id str

The user ID that the VpcID of ingress_vpc_id belongs to.

ingress_vswitch_id str

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instance_cidr str

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instance_type str

The type of the instance. Valid values are:

ipv6_enabled bool

Specifies whether IPv6 ingress capability is enabled.

pricing_cycle str

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skip_wait_switch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

to_connect_vpc_ip_block InstanceToConnectVpcIpBlockArgs

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

user_vpc_id str

User's VpcID.

vpc_slb_intranet_enable bool

Whether the slb of the Vpc supports.

zone_id str

The zone where the instance is deployed.

zone_vswitch_security_groups Sequence[InstanceZoneVswitchSecurityGroupArgs]

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

httpsPolicy String

Https policy.

instanceName String

Instance name.

instanceSpec String

Instance spec.

paymentType String

The payment type of the resource.

deleteVpcIpBlock String

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration Number

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable Boolean

Specifies whether IPv6 egress capability is enabled.

ingressVpcId String

The VpcID which the client at.

ingressVpcOwnerId String

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId String

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr String

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceType String

The type of the instance. Valid values are:

ipv6Enabled Boolean

Specifies whether IPv6 ingress capability is enabled.

pricingCycle String

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch Boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

toConnectVpcIpBlock Property Map

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId String

User's VpcID.

vpcSlbIntranetEnable Boolean

Whether the slb of the Vpc supports.

zoneId String

The zone where the instance is deployed.

zoneVswitchSecurityGroups List<Property Map>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

Outputs

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

ConnectCidrBlocks string: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
CreateTime string: Creation time.
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource.
SupportIpv6 bool: Does ipv6 support.

ConnectCidrBlocks string: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
CreateTime string: Creation time.
Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of the resource.
SupportIpv6 bool: Does ipv6 support.

connectCidrBlocks String: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
createTime String: Creation time.
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource.
supportIpv6 Boolean: Does ipv6 support.

connectCidrBlocks string: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
createTime string: Creation time.
id string: The provider-assigned unique ID for this managed resource.
status string: The status of the resource.
supportIpv6 boolean: Does ipv6 support.

connect_cidr_blocks str: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
create_time str: Creation time.
id str: The provider-assigned unique ID for this managed resource.
status str: The status of the resource.
support_ipv6 bool: Does ipv6 support.

connectCidrBlocks String: (Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.
createTime String: Creation time.
id String: The provider-assigned unique ID for this managed resource.
status String: The status of the resource.
supportIpv6 Boolean: Does ipv6 support.

Look up Existing Instance Resource

Get an existing Instance 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?: InstanceState, opts?: CustomResourceOptions): Instance

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connect_cidr_blocks: Optional[str] = None,
        create_time: Optional[str] = None,
        delete_vpc_ip_block: Optional[str] = None,
        duration: Optional[int] = None,
        egress_ipv6_enable: Optional[bool] = None,
        https_policy: Optional[str] = None,
        ingress_vpc_id: Optional[str] = None,
        ingress_vpc_owner_id: Optional[str] = None,
        ingress_vswitch_id: Optional[str] = None,
        instance_cidr: Optional[str] = None,
        instance_name: Optional[str] = None,
        instance_spec: Optional[str] = None,
        instance_type: Optional[str] = None,
        ipv6_enabled: Optional[bool] = None,
        payment_type: Optional[str] = None,
        pricing_cycle: Optional[str] = None,
        skip_wait_switch: Optional[bool] = None,
        status: Optional[str] = None,
        support_ipv6: Optional[bool] = None,
        to_connect_vpc_ip_block: Optional[InstanceToConnectVpcIpBlockArgs] = None,
        user_vpc_id: Optional[str] = None,
        vpc_slb_intranet_enable: Optional[bool] = None,
        zone_id: Optional[str] = None,
        zone_vswitch_security_groups: Optional[Sequence[InstanceZoneVswitchSecurityGroupArgs]] = None) -> Instance

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

public static Instance Get(string name, Input<string> id, InstanceState? state, CustomResourceOptions? opts = null)

public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)

resources:  _:    type: alicloud:apigateway:Instance    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:

ConnectCidrBlocks string

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

CreateTime string

Creation time.

DeleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

Duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

EgressIpv6Enable bool

Specifies whether IPv6 egress capability is enabled.

HttpsPolicy string

Https policy.

IngressVpcId string

The VpcID which the client at.

IngressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

IngressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

InstanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

InstanceName string

Instance name.

InstanceSpec string

Instance spec.

InstanceType string

The type of the instance. Valid values are:

Ipv6Enabled bool

Specifies whether IPv6 ingress capability is enabled.

PaymentType string

The payment type of the resource.

PricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

SkipWaitSwitch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

Status string

The status of the resource.

SupportIpv6 bool

Does ipv6 support.

ToConnectVpcIpBlock Pulumi.AliCloud.ApiGateway.Inputs.InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

UserVpcId string

User's VpcID.

VpcSlbIntranetEnable bool

Whether the slb of the Vpc supports.

ZoneId string

The zone where the instance is deployed.

ZoneVswitchSecurityGroups List<Pulumi.AliCloud.ApiGateway.Inputs.InstanceZoneVswitchSecurityGroup>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

ConnectCidrBlocks string

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

CreateTime string

Creation time.

DeleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

Duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

EgressIpv6Enable bool

Specifies whether IPv6 egress capability is enabled.

HttpsPolicy string

Https policy.

IngressVpcId string

The VpcID which the client at.

IngressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

IngressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

InstanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

InstanceName string

Instance name.

InstanceSpec string

Instance spec.

InstanceType string

The type of the instance. Valid values are:

Ipv6Enabled bool

Specifies whether IPv6 ingress capability is enabled.

PaymentType string

The payment type of the resource.

PricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

SkipWaitSwitch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

Status string

The status of the resource.

SupportIpv6 bool

Does ipv6 support.

ToConnectVpcIpBlock InstanceToConnectVpcIpBlockArgs

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

UserVpcId string

User's VpcID.

VpcSlbIntranetEnable bool

Whether the slb of the Vpc supports.

ZoneId string

The zone where the instance is deployed.

ZoneVswitchSecurityGroups []InstanceZoneVswitchSecurityGroupArgs

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

connectCidrBlocks String

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

createTime String

Creation time.

deleteVpcIpBlock String

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration Integer

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable Boolean

Specifies whether IPv6 egress capability is enabled.

httpsPolicy String

Https policy.

ingressVpcId String

The VpcID which the client at.

ingressVpcOwnerId String

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId String

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr String

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceName String

Instance name.

instanceSpec String

Instance spec.

instanceType String

The type of the instance. Valid values are:

ipv6Enabled Boolean

Specifies whether IPv6 ingress capability is enabled.

paymentType String

The payment type of the resource.

pricingCycle String

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch Boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

status String

The status of the resource.

supportIpv6 Boolean

Does ipv6 support.

toConnectVpcIpBlock InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId String

User's VpcID.

vpcSlbIntranetEnable Boolean

Whether the slb of the Vpc supports.

zoneId String

The zone where the instance is deployed.

zoneVswitchSecurityGroups List<InstanceZoneVswitchSecurityGroup>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

connectCidrBlocks string

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

createTime string

Creation time.

deleteVpcIpBlock string

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration number

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable boolean

Specifies whether IPv6 egress capability is enabled.

httpsPolicy string

Https policy.

ingressVpcId string

The VpcID which the client at.

ingressVpcOwnerId string

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId string

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr string

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceName string

Instance name.

instanceSpec string

Instance spec.

instanceType string

The type of the instance. Valid values are:

ipv6Enabled boolean

Specifies whether IPv6 ingress capability is enabled.

paymentType string

The payment type of the resource.

pricingCycle string

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

status string

The status of the resource.

supportIpv6 boolean

Does ipv6 support.

toConnectVpcIpBlock InstanceToConnectVpcIpBlock

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId string

User's VpcID.

vpcSlbIntranetEnable boolean

Whether the slb of the Vpc supports.

zoneId string

The zone where the instance is deployed.

zoneVswitchSecurityGroups InstanceZoneVswitchSecurityGroup[]

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

connect_cidr_blocks str

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

create_time str

Creation time.

delete_vpc_ip_block str

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration int

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egress_ipv6_enable bool

Specifies whether IPv6 egress capability is enabled.

https_policy str

Https policy.

ingress_vpc_id str

The VpcID which the client at.

ingress_vpc_owner_id str

The user ID that the VpcID of ingress_vpc_id belongs to.

ingress_vswitch_id str

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instance_cidr str

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instance_name str

Instance name.

instance_spec str

Instance spec.

instance_type str

The type of the instance. Valid values are:

ipv6_enabled bool

Specifies whether IPv6 ingress capability is enabled.

payment_type str

The payment type of the resource.

pricing_cycle str

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skip_wait_switch bool

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

status str

The status of the resource.

support_ipv6 bool

Does ipv6 support.

to_connect_vpc_ip_block InstanceToConnectVpcIpBlockArgs

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

user_vpc_id str

User's VpcID.

vpc_slb_intranet_enable bool

Whether the slb of the Vpc supports.

zone_id str

The zone where the instance is deployed.

zone_vswitch_security_groups Sequence[InstanceZoneVswitchSecurityGroupArgs]

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

connectCidrBlocks String

(Available since v1.228.0) The CIDR blocks that can be accessed by the Vpc integration instance.

createTime String

Creation time.

deleteVpcIpBlock String

Indicates whether to delete the IP block that the VPC can access, conflict with to_connect_vpc_ip_block.

duration Number

The time of the instance package. Valid values:

PricingCycle is Month, indicating monthly payment. The value range is 1 to 9.
PricingCycle is Year, indicating annual payment. The value range is 1 to 3.

When the value of> ChargeType is PrePaid, this parameter is available and must be passed in.

egressIpv6Enable Boolean

Specifies whether IPv6 egress capability is enabled.

httpsPolicy String

Https policy.

ingressVpcId String

The VpcID which the client at.

ingressVpcOwnerId String

The user ID that the VpcID of ingress_vpc_id belongs to.

ingressVswitchId String

The VSwitch ID that belongs to the Vpc of ingress_vpc_id. Required when ingress_vpc_id is set.

instanceCidr String

The CIDR block for the instance deployment. Valid values are:

192.168.0.0/16.
172.16.0.0/12.

instanceName String

Instance name.

instanceSpec String

Instance spec.

instanceType String

The type of the instance. Valid values are:

ipv6Enabled Boolean

Specifies whether IPv6 ingress capability is enabled.

paymentType String

The payment type of the resource.

pricingCycle String

The subscription instance is of the subscription year or month type. This parameter is required when the Payment type is PrePaid. The value range is as follows:

skipWaitSwitch Boolean

Specifies whether to skip the WAIT_SWITCH status of instance when modifying instance spec. Works only when instance spec change.

status String

The status of the resource.

supportIpv6 Boolean

Does ipv6 support.

toConnectVpcIpBlock Property Map

The additional IP block that the VPC integration instance can access, conflict with delete_vpc_ip_block. See to_connect_vpc_ip_block below.

userVpcId String

User's VpcID.

vpcSlbIntranetEnable Boolean

Whether the slb of the Vpc supports.

zoneId String

The zone where the instance is deployed.

zoneVswitchSecurityGroups List<Property Map>

Network configuration details for Vpc integration instance which includes the availability zone, VSwitch, and security group information. See zone_vswitch_security_group below.

Supporting Types

InstanceToConnectVpcIpBlock, InstanceToConnectVpcIpBlockArgs

CidrBlock string: The CIDR block of the VSwitch.
Customized bool: Specifies whether the IP block is customized.
VswitchId string: The VSwitch ID.
ZoneId string: The zone ID.

CidrBlock string: The CIDR block of the VSwitch.
Customized bool: Specifies whether the IP block is customized.
VswitchId string: The VSwitch ID.
ZoneId string: The zone ID.

cidrBlock String: The CIDR block of the VSwitch.
customized Boolean: Specifies whether the IP block is customized.
vswitchId String: The VSwitch ID.
zoneId String: The zone ID.

cidrBlock string: The CIDR block of the VSwitch.
customized boolean: Specifies whether the IP block is customized.
vswitchId string: The VSwitch ID.
zoneId string: The zone ID.

cidr_block str: The CIDR block of the VSwitch.
customized bool: Specifies whether the IP block is customized.
vswitch_id str: The VSwitch ID.
zone_id str: The zone ID.

cidrBlock String: The CIDR block of the VSwitch.
customized Boolean: Specifies whether the IP block is customized.
vswitchId String: The VSwitch ID.
zoneId String: The zone ID.

InstanceZoneVswitchSecurityGroup, InstanceZoneVswitchSecurityGroupArgs

CidrBlock string: The CIDR block of the VSwitch.
SecurityGroup string: The ID of the security group.
VswitchId string: The VSwitch ID.
ZoneId string: The zone ID.

CidrBlock string: The CIDR block of the VSwitch.
SecurityGroup string: The ID of the security group.
VswitchId string: The VSwitch ID.
ZoneId string: The zone ID.

cidrBlock String: The CIDR block of the VSwitch.
securityGroup String: The ID of the security group.
vswitchId String: The VSwitch ID.
zoneId String: The zone ID.

cidrBlock string: The CIDR block of the VSwitch.
securityGroup string: The ID of the security group.
vswitchId string: The VSwitch ID.
zoneId string: The zone ID.

cidr_block str: The CIDR block of the VSwitch.
security_group str: The ID of the security group.
vswitch_id str: The VSwitch ID.
zone_id str: The zone ID.

cidrBlock String: The CIDR block of the VSwitch.
securityGroup String: The ID of the security group.
vswitchId String: The VSwitch ID.
zoneId String: The zone ID.

Import

Api Gateway Instance can be imported using the id, e.g.

$ pulumi import alicloud:apigateway/instance:Instance example <id>

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

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.

Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-alicloud

alicloud.apigateway.Instance

On this page

On this page

Example Usage

Create Instance Resource

Constructor syntax

Parameters

Constructor example

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceToConnectVpcIpBlock, InstanceToConnectVpcIpBlockArgs

InstanceZoneVswitchSecurityGroup, InstanceZoneVswitchSecurityGroupArgs

Import

Package Details

On this page

On this page