1. Docs
  2. Reference
  3. API
  4. @pulumi/alicloud
  5. vpc

Module vpc

This page documents the language specification for the alicloud package. If you're looking for help working with the inputs, outputs, or functions of alicloud resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-alicloud repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-alicloud repo.

Resources

Functions

Others

Resources

Resource CommonBandwithPackage

class CommonBandwithPackage extends CustomResource

constructor

new CommonBandwithPackage(name: string, args: CommonBandwithPackageArgs, opts?: pulumi.CustomResourceOptions)

Create a CommonBandwithPackage resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CommonBandwithPackageState, opts?: pulumi.CustomResourceOptions): CommonBandwithPackage

Get an existing CommonBandwithPackage resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CommonBandwithPackage

Returns true if the given object is an instance of CommonBandwithPackage. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bandwidth

public bandwidth: pulumi.Output<number>;

The bandwidth of the common bandwidth package, in Mbps.

property description

public description: pulumi.Output<string | undefined>;

The description of the common bandwidth package instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property internetChargeType

public internetChargeType: pulumi.Output<string | undefined>;

The billing method of the common bandwidth package. Valid values are “PayByBandwidth” and “PayBy95” and “PayByTraffic”. “PayBy95” is pay by classic 95th percentile pricing. International Account doesn’t supports “PayByBandwidth” and “PayBy95”. Default to “PayByTraffic”.

property name

public name: pulumi.Output<string>;

The name of the common bandwidth package.

property ratio

public ratio: pulumi.Output<number | undefined>;

Ratio of the common bandwidth package. It is valid when internetChargeType is PayBy95. Default to 100. Valid values: [10-100].

property resourceGroupId

public resourceGroupId: pulumi.Output<string>;

The Id of resource group which the common bandwidth package belongs.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource CommonBandwithPackageAttachment

class CommonBandwithPackageAttachment extends CustomResource

constructor

new CommonBandwithPackageAttachment(name: string, args: CommonBandwithPackageAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a CommonBandwithPackageAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CommonBandwithPackageAttachmentState, opts?: pulumi.CustomResourceOptions): CommonBandwithPackageAttachment

Get an existing CommonBandwithPackageAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is CommonBandwithPackageAttachment

Returns true if the given object is an instance of CommonBandwithPackageAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bandwidthPackageId

public bandwidthPackageId: pulumi.Output<string>;

The bandwidthPackageId of the common bandwidth package attachment, the field can’t be changed.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The instanceId of the common bandwidth package attachment, the field can’t be changed.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ForwardEntry

class ForwardEntry extends CustomResource

Provides a forward resource.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "forward-entry-example-name";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/21",
    vpcId: defaultNetwork.id,
});
const defaultNatGateway = new alicloud.vpc.NatGateway("default", {
    specification: "Small",
    vpcId: defaultNetwork.id,
});
const defaultEip = new alicloud.ecs.Eip("default", {});
const defaultEipAssociation = new alicloud.ecs.EipAssociation("default", {
    allocationId: defaultEip.id,
    instanceId: defaultNatGateway.id,
});
const defaultForwardEntry = new alicloud.vpc.ForwardEntry("default", {
    externalIp: defaultEip.ipAddress,
    externalPort: "80",
    forwardTableId: defaultNatGateway.forwardTableIds,
    internalIp: "172.16.0.3",
    internalPort: "8080",
    ipProtocol: "tcp",
});

constructor

new ForwardEntry(name: string, args: ForwardEntryArgs, opts?: pulumi.CustomResourceOptions)

Create a ForwardEntry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ForwardEntryState, opts?: pulumi.CustomResourceOptions): ForwardEntry

Get an existing ForwardEntry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ForwardEntry

Returns true if the given object is an instance of ForwardEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property externalIp

public externalIp: pulumi.Output<string>;

The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property externalPort

public externalPort: pulumi.Output<string>;

The external port, valid value is 1~65535|any.

property forwardEntryId

public forwardEntryId: pulumi.Output<string>;

The id of the forward entry on the server.

property forwardTableId

public forwardTableId: pulumi.Output<string>;

The value can get from alicloud.vpc.NatGateway Attributes “forwardTableIds”.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property internalIp

public internalIp: pulumi.Output<string>;

The internal ip, must a private ip.

property internalPort

public internalPort: pulumi.Output<string>;

The internal port, valid value is 1~65535|any.

property ipProtocol

public ipProtocol: pulumi.Output<string>;

The ip protocal, valid value is tcp|udp|any.

property name

public name: pulumi.Output<string>;

The name of forward entry.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource HAVip

class HAVip extends CustomResource

constructor

new HAVip(name: string, args: HAVipArgs, opts?: pulumi.CustomResourceOptions)

Create a HAVip resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HAVipState, opts?: pulumi.CustomResourceOptions): HAVip

Get an existing HAVip resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is HAVip

Returns true if the given object is an instance of HAVip. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the HaVip instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ipAddress

public ipAddress: pulumi.Output<string>;

The ip address of the HaVip. If not filled, the default will be assigned one from the vswitch.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string>;

The vswitchId of the HaVip, the field can’t be changed.

Resource HAVipAttachment

class HAVipAttachment extends CustomResource

constructor

new HAVipAttachment(name: string, args: HAVipAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a HAVipAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HAVipAttachmentState, opts?: pulumi.CustomResourceOptions): HAVipAttachment

Get an existing HAVipAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is HAVipAttachment

Returns true if the given object is an instance of HAVipAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property havipId

public havipId: pulumi.Output<string>;

The havipId of the havip attachment, the field can’t be changed.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The instanceId of the havip attachment, the field can’t be changed.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NatGateway

class NatGateway extends CustomResource

constructor

new NatGateway(name: string, args: NatGatewayArgs, opts?: pulumi.CustomResourceOptions)

Create a NatGateway resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NatGatewayState, opts?: pulumi.CustomResourceOptions): NatGateway

Get an existing NatGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NatGateway

Returns true if the given object is an instance of NatGateway. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property bandwidthPackageIds

public bandwidthPackageIds: pulumi.Output<string>;

A list ID of the bandwidth packages, and split them with commas.

property bandwidthPackages

public bandwidthPackages: pulumi.Output<NatGatewayBandwidthPackage[] | undefined>;

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

property description

public description: pulumi.Output<string | undefined>;

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

property forwardTableIds

public forwardTableIds: pulumi.Output<string>;

The nat gateway will auto create a snap and forward item, the forwardTableIds is the created one.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string>;

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

property name

public name: pulumi.Output<string>;

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

property period

public period: pulumi.Output<number | undefined>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property snatTableIds

public snatTableIds: pulumi.Output<string>;

The nat gateway will auto create a snap and forward item, the snatTableIds is the created one.

property spec

public spec: pulumi.Output<string | undefined>;

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

property specification

public specification: pulumi.Output<string | undefined>;

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The VPC ID.

Resource Network

class Network extends CustomResource

constructor

new Network(name: string, args: NetworkArgs, opts?: pulumi.CustomResourceOptions)

Create a Network resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkState, opts?: pulumi.CustomResourceOptions): Network

Get an existing Network resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Network

Returns true if the given object is an instance of Network. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property cidrBlock

public cidrBlock: pulumi.Output<string>;

The CIDR block for the VPC.

property description

public description: pulumi.Output<string | undefined>;

The VPC description. Defaults to null.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the VPC. Defaults to null.

property resourceGroupId

public resourceGroupId: pulumi.Output<string>;

The Id of resource group which the VPC belongs.

property routeTableId

public routeTableId: pulumi.Output<string>;

The route table ID of the router created by default on VPC creation.

property routerId

public routerId: pulumi.Output<string>;

The ID of the router created by default on VPC creation.

property routerTableId

public routerTableId: pulumi.Output<string>;

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkAcl

class NetworkAcl extends CustomResource

Provides a network acl resource to add network acls.

NOTE: Available in 1.43.0+. Currently, the resource are only available in Hongkong(cn-hongkong), India(ap-south-1), and Indonesia(ap-southeast-1) regions.

Example Usage

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

const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultNetworkAcl = new alicloud.vpc.NetworkAcl("default", {
    description: "networkAcl",
    vpcId: defaultNetwork.id,
});

constructor

new NetworkAcl(name: string, args: NetworkAclArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkAcl resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAclState, opts?: pulumi.CustomResourceOptions): NetworkAcl

Get an existing NetworkAcl resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkAcl

Returns true if the given object is an instance of NetworkAcl. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the network acl instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the network acl.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The vpcId of the network acl, the field can’t be changed.

Resource NetworkAclAttachment

class NetworkAclAttachment extends CustomResource

Provides a network acl attachment resource to associate network acls to vswitches.

NOTE: Available in 1.44.0+. Currently, the resource are only available in Hongkong(cn-hongkong), India(ap-south-1), and Indonesia(ap-southeast-1) regions.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "NatGatewayConfigSpec";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultNetworkAcl = new alicloud.vpc.NetworkAcl("default", {
    vpcId: defaultNetwork.id,
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/21",
    vpcId: defaultNetwork.id,
});
const defaultNetworkAclAttachment = new alicloud.vpc.NetworkAclAttachment("default", {
    networkAclId: defaultNetworkAcl.id,
    resources: [{
        resourceId: defaultSwitch.id,
        resourceType: "VSwitch",
    }],
});

constructor

new NetworkAclAttachment(name: string, args: NetworkAclAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkAclAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAclAttachmentState, opts?: pulumi.CustomResourceOptions): NetworkAclAttachment

Get an existing NetworkAclAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkAclAttachment

Returns true if the given object is an instance of NetworkAclAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property networkAclId

public networkAclId: pulumi.Output<string>;

The id of the network acl, the field can’t be changed.

property resources

public resources: pulumi.Output<NetworkAclAttachmentResource[]>;

List of the resources associated with the network acl. The details see Block Resources.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkAclEntries

class NetworkAclEntries extends CustomResource

Provides a network acl entries resource to create ingress and egress entries.

NOTE: Available in 1.45.0+. Currently, the resource are only available in Hongkong(cn-hongkong), India(ap-south-1), and Indonesia(ap-southeast-1) regions.

NOTE: It doesn’t support concurrency and the order of the ingress and egress entries determines the priority.

NOTE: Using this resource need to open a whitelist.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "NetworkAclEntries";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultNetworkAcl = new alicloud.vpc.NetworkAcl("default", {
    vpcId: defaultNetwork.id,
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/21",
    vpcId: defaultNetwork.id,
});
const defaultNetworkAclAttachment = new alicloud.vpc.NetworkAclAttachment("default", {
    networkAclId: defaultNetworkAcl.id,
    resources: [{
        resourceId: defaultSwitch.id,
        resourceType: "VSwitch",
    }],
});
const defaultNetworkAclEntries = new alicloud.vpc.NetworkAclEntries("default", {
    egresses: [{
        description: name,
        destinationCidrIp: "0.0.0.0/32",
        entryType: "custom",
        name: name,
        policy: "accept",
        port: "-1/-1",
        protocol: "all",
    }],
    ingresses: [{
        description: name,
        entryType: "custom",
        name: name,
        policy: "accept",
        port: "-1/-1",
        protocol: "all",
        sourceCidrIp: "0.0.0.0/32",
    }],
    networkAclId: defaultNetworkAcl.id,
});

constructor

new NetworkAclEntries(name: string, args: NetworkAclEntriesArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkAclEntries resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkAclEntriesState, opts?: pulumi.CustomResourceOptions): NetworkAclEntries

Get an existing NetworkAclEntries resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkAclEntries

Returns true if the given object is an instance of NetworkAclEntries. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property egresses

public egresses: pulumi.Output<NetworkAclEntriesEgress[] | undefined>;

List of the egress entries of the network acl. The order of the egress entries determines the priority. The details see Block Egress.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property ingresses

public ingresses: pulumi.Output<NetworkAclEntriesIngress[] | undefined>;

List of the ingress entries of the network acl. The order of the ingress entries determines the priority. The details see Block Ingress.

property networkAclId

public networkAclId: pulumi.Output<string>;

The id of the network acl, the field can’t be changed.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource NetworkInterface

class NetworkInterface extends CustomResource

Provides an ECS Elastic Network Interface resource.

For information about Elastic Network Interface and how to use it, see Elastic Network Interface.

NOTE Only one of privateIps or privateIpsCount can be specified when assign private IPs.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "networkInterfaceName";

const vpc = new alicloud.vpc.Network("vpc", {
    cidrBlock: "192.168.0.0/24",
});
const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const vswitch = new alicloud.vpc.Switch("vswitch", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "192.168.0.0/24",
    vpcId: vpc.id,
});
const group = new alicloud.ecs.SecurityGroup("group", {
    vpcId: vpc.id,
});
const defaultNetworkInterface = new alicloud.vpc.NetworkInterface("default", {
    privateIp: "192.168.0.2",
    privateIpsCount: 3,
    securityGroups: [group.id],
    vswitchId: vswitch.id,
});

constructor

new NetworkInterface(name: string, args: NetworkInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceState, opts?: pulumi.CustomResourceOptions): NetworkInterface

Get an existing NetworkInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterface

Returns true if the given object is an instance of NetworkInterface. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

Description of the ENI. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property mac

public mac: pulumi.Output<string>;

(Available in 1.54.0+) The MAC address of an ENI.

property name

public name: pulumi.Output<string>;

Name of the ENI. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”, “.”, “_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.

property privateIp

public privateIp: pulumi.Output<string>;

The primary private IP of the ENI.

property privateIps

public privateIps: pulumi.Output<string[]>;

List of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property privateIpsCount

public privateIpsCount: pulumi.Output<number>;

Number of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property resourceGroupId

public resourceGroupId: pulumi.Output<string | undefined>;

The Id of resource group which the network interface belongs.

property securityGroups

public securityGroups: pulumi.Output<string[]>;

A list of security group ids to associate with.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string>;

The VSwitch to create the ENI in.

Resource NetworkInterfaceAttachment

class NetworkInterfaceAttachment extends CustomResource

Provides an Alicloud ECS Elastic Network Interface Attachment as a resource to attach ENI to or detach ENI from ECS Instances.

For information about Elastic Network Interface and how to use it, see Elastic Network Interface.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "networkInterfaceAttachment";
const number = config.get("number") || "2";

const vpc = new alicloud.vpc.Network("vpc", {
    cidrBlock: "192.168.0.0/24",
});
const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const vswitch = new alicloud.vpc.Switch("vswitch", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "192.168.0.0/24",
    vpcId: vpc.id,
});
const group = new alicloud.ecs.SecurityGroup("group", {
    vpcId: vpc.id,
});
const instanceType = defaultZones.apply(defaultZones => alicloud.ecs.getInstanceTypes({
    availabilityZone: defaultZones.zones[0].id,
    eniAmount: 2,
}, { async: true }));
const defaultImages = pulumi.output(alicloud.ecs.getImages({
    mostRecent: true,
    nameRegex: "^ubuntu_18.*64",
    owners: "system",
}, { async: true }));
const instance: alicloud.ecs.Instance[] = [];
for (let i = 0; i < number; i++) {
    instance.push(new alicloud.ecs.Instance(`instance-${i}`, {
        availabilityZone: defaultZones.zones[0].id,
        imageId: defaultImages.images[0].id,
        instanceName: name,
        instanceType: instanceType.instanceTypes[0].id,
        internetMaxBandwidthOut: 10,
        securityGroups: [group.id],
        systemDiskCategory: "cloudEfficiency",
        vswitchId: vswitch.id,
    }));
}
const interfaceNetworkInterface: alicloud.vpc.NetworkInterface[] = [];
for (let i = 0; i < number; i++) {
    interfaceNetworkInterface.push(new alicloud.vpc.NetworkInterface(`interface-${i}`, {
        securityGroups: [group.id],
        vswitchId: vswitch.id,
    }));
}
const attachment: alicloud.vpc.NetworkInterfaceAttachment[] = [];
for (let i = 0; i < number; i++) {
    attachment.push(new alicloud.vpc.NetworkInterfaceAttachment(`attachment-${i}`, {
        instanceId: pulumi.all(instance.map(v => v.id)).apply(id => id.map(v => v)[i]),
        networkInterfaceId: pulumi.all(interfaceNetworkInterface.map(v => v.id)).apply(id => id.map(v => v)[i]),
    }));
}

constructor

new NetworkInterfaceAttachment(name: string, args: NetworkInterfaceAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a NetworkInterfaceAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: NetworkInterfaceAttachmentState, opts?: pulumi.CustomResourceOptions): NetworkInterfaceAttachment

Get an existing NetworkInterfaceAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is NetworkInterfaceAttachment

Returns true if the given object is an instance of NetworkInterfaceAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceId

public instanceId: pulumi.Output<string>;

The instance ID to attach.

property networkInterfaceId

public networkInterfaceId: pulumi.Output<string>;

The ENI ID to attach.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouteEntry

class RouteEntry extends CustomResource

constructor

new RouteEntry(name: string, args: RouteEntryArgs, opts?: pulumi.CustomResourceOptions)

Create a RouteEntry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteEntryState, opts?: pulumi.CustomResourceOptions): RouteEntry

Get an existing RouteEntry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouteEntry

Returns true if the given object is an instance of RouteEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property destinationCidrblock

public destinationCidrblock: pulumi.Output<string | undefined>;

The RouteEntry’s target network segment.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the route entry. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://.

property nexthopId

public nexthopId: pulumi.Output<string | undefined>;

The route entry’s next hop. ECS instance ID or VPC router interface ID.

property nexthopType

public nexthopType: pulumi.Output<string | undefined>;

The next hop type. Available values: - Instance (Default): Route the traffic destined for the destination CIDR block to an ECS instance in the VPC. - RouterInterface: Route the traffic destined for the destination CIDR block to a router interface. - VpnGateway: Route the traffic destined for the destination CIDR block to a VPN Gateway. - HaVip: Route the traffic destined for the destination CIDR block to an HAVIP. - NetworkInterface: Route the traffic destined for the destination CIDR block to an NetworkInterface. - NatGateway: Route the traffic destined for the destination CIDR block to an Nat Gateway.

property routeTableId

public routeTableId: pulumi.Output<string>;

The ID of the route table.

property routerId

public routerId: pulumi.Output<string>;

This argument has beeb deprecated. Please use other arguments to launch a custom route entry.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouterInterface

class RouterInterface extends CustomResource

constructor

new RouterInterface(name: string, args: RouterInterfaceArgs, opts?: pulumi.CustomResourceOptions)

Create a RouterInterface resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouterInterfaceState, opts?: pulumi.CustomResourceOptions): RouterInterface

Get an existing RouterInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouterInterface

Returns true if the given object is an instance of RouterInterface. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessPointId

public accessPointId: pulumi.Output<string>;

It has been deprecated from version 1.11.0.

property description

public description: pulumi.Output<string | undefined>;

Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.

property healthCheckSourceIp

public healthCheckSourceIp: pulumi.Output<string | undefined>;

Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckTargetIp must be specified at the same time.

property healthCheckTargetIp

public healthCheckTargetIp: pulumi.Output<string | undefined>;

Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckSourceIp must be specified at the same time.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceChargeType

public instanceChargeType: pulumi.Output<string | undefined>;

The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and oppositeRegion are the same.

property name

public name: pulumi.Output<string>;

Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.

property oppositeAccessPointId

public oppositeAccessPointId: pulumi.Output<string | undefined>;

It has been deprecated from version 1.11.0.

property oppositeInterfaceId

public oppositeInterfaceId: pulumi.Output<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.

property oppositeInterfaceOwnerId

public oppositeInterfaceOwnerId: pulumi.Output<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.

property oppositeRegion

public oppositeRegion: pulumi.Output<string>;

The Region of peer side.

property oppositeRouterId

public oppositeRouterId: pulumi.Output<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.

property oppositeRouterType

public oppositeRouterType: pulumi.Output<string>;

It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.

property period

public period: pulumi.Output<number | undefined>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property role

public role: pulumi.Output<string>;

The role the router interface plays. Optional value: InitiatingSide, AcceptingSide.

property routerId

public routerId: pulumi.Output<string>;

The Router ID.

property routerType

public routerType: pulumi.Output<string>;

Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.

property specification

public specification: pulumi.Output<string | undefined>;

Specification of router interfaces. It is valid when role is InitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouterInterfaceConnection

class RouterInterfaceConnection extends CustomResource

Provides a VPC router interface connection resource to connect two router interfaces which are in two different VPCs. After that, all of the two router interfaces will be active.

NOTE: At present, Router interface does not support changing opposite router interface, the connection delete action is only deactivating it to inactive, not modifying the connection to empty.

NOTE: If you want to changing opposite router interface, you can delete router interface and re-build them.

NOTE: A integrated router interface connection tunnel requires both InitiatingSide and AcceptingSide configuring opposite router interface.

NOTE: Please remember to add a dependsOn clause in the router interface connection from the InitiatingSide to the AcceptingSide, because the connection from the AcceptingSide to the InitiatingSide must be done first.

Example Usage

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

const config = new pulumi.Config();
const region = config.get("region") || "cn-hangzhou";
const name = config.get("name") || "alicloudRouterInterfaceConnectionBasic";

const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "172.16.0.0/12",
});
const barNetwork = new alicloud.vpc.Network("bar", {
    cidrBlock: "192.168.0.0/16",
});
const initiate = new alicloud.vpc.RouterInterface("initiate", {
    description: name,
    instanceChargeType: "PostPaid",
    oppositeRegion: region,
    role: "InitiatingSide",
    routerId: fooNetwork.routerId,
    routerType: "VRouter",
    specification: "Large.2",
});
const opposite = new alicloud.vpc.RouterInterface("opposite", {
    description: `${name}-opposite`,
    oppositeRegion: region,
    role: "AcceptingSide",
    routerId: barNetwork.routerId,
    routerType: "VRouter",
    specification: "Large.1",
});
const barRouterInterfaceConnection = new alicloud.vpc.RouterInterfaceConnection("bar", {
    interfaceId: opposite.id,
    oppositeInterfaceId: initiate.id,
});
// A integrated router interface connection tunnel requires both InitiatingSide and AcceptingSide configuring opposite router interface.
const fooRouterInterfaceConnection = new alicloud.vpc.RouterInterfaceConnection("foo", {
    interfaceId: initiate.id,
    oppositeInterfaceId: opposite.id,
}, { dependsOn: [barRouterInterfaceConnection] });

constructor

new RouterInterfaceConnection(name: string, args: RouterInterfaceConnectionArgs, opts?: pulumi.CustomResourceOptions)

Create a RouterInterfaceConnection resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouterInterfaceConnectionState, opts?: pulumi.CustomResourceOptions): RouterInterfaceConnection

Get an existing RouterInterfaceConnection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouterInterfaceConnection

Returns true if the given object is an instance of RouterInterfaceConnection. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property interfaceId

public interfaceId: pulumi.Output<string>;

One side router interface ID.

property oppositeInterfaceId

public oppositeInterfaceId: pulumi.Output<string>;

Another side router interface ID. It must belong the specified “oppositeInterfaceOwnerId” account.

property oppositeInterfaceOwnerId

public oppositeInterfaceOwnerId: pulumi.Output<string>;

property oppositeRouterId

public oppositeRouterId: pulumi.Output<string>;

Another side router ID. It must belong the specified “oppositeInterfaceOwnerId” account. It is valid when field “oppositeInterfaceOwnerId” is specified.

property oppositeRouterType

public oppositeRouterType: pulumi.Output<string | undefined>;

Another side router Type. Optional value: VRouter, VBR. It is valid when field “oppositeInterfaceOwnerId” is specified.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RouteTable

class RouteTable extends CustomResource

constructor

new RouteTable(name: string, args: RouteTableArgs, opts?: pulumi.CustomResourceOptions)

Create a RouteTable resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteTableState, opts?: pulumi.CustomResourceOptions): RouteTable

Get an existing RouteTable resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouteTable

Returns true if the given object is an instance of RouteTable. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property description

public description: pulumi.Output<string | undefined>;

The description of the route table instance.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the route table.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The vpcId of the route table, the field can’t be changed.

Resource RouteTableAttachment

class RouteTableAttachment extends CustomResource

constructor

new RouteTableAttachment(name: string, args: RouteTableAttachmentArgs, opts?: pulumi.CustomResourceOptions)

Create a RouteTableAttachment resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteTableAttachmentState, opts?: pulumi.CustomResourceOptions): RouteTableAttachment

Get an existing RouteTableAttachment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RouteTableAttachment

Returns true if the given object is an instance of RouteTableAttachment. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property routeTableId

public routeTableId: pulumi.Output<string>;

The routeTableId of the route table attachment, the field can’t be changed.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vswitchId

public vswitchId: pulumi.Output<string>;

The vswitchId of the route table attachment, the field can’t be changed.

Resource SnatEntry

class SnatEntry extends CustomResource

Provides a snat resource.

constructor

new SnatEntry(name: string, args: SnatEntryArgs, opts?: pulumi.CustomResourceOptions)

Create a SnatEntry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SnatEntryState, opts?: pulumi.CustomResourceOptions): SnatEntry

Get an existing SnatEntry resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SnatEntry

Returns true if the given object is an instance of SnatEntry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property snatEntryId

public snatEntryId: pulumi.Output<string>;

The id of the snat entry on the server.

property snatEntryName

public snatEntryName: pulumi.Output<string | undefined>;

The name of snat entry.

property snatIp

public snatIp: pulumi.Output<string>;

The SNAT ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property snatTableId

public snatTableId: pulumi.Output<string>;

The value can get from alicloud.vpc.NatGateway Attributes “snatTableIds”.

property sourceCidr

public sourceCidr: pulumi.Output<string | undefined>;

The private network segment of Ecs. This parameter and the sourceVswitchId parameter are mutually exclusive and cannot appear at the same time.

property sourceVswitchId

public sourceVswitchId: pulumi.Output<string | undefined>;

The vswitch ID.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Subnet

class Subnet extends CustomResource

constructor

new Subnet(name: string, args: SubnetArgs, opts?: pulumi.CustomResourceOptions)

Create a Subnet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SubnetState, opts?: pulumi.CustomResourceOptions): Subnet

Get an existing Subnet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Subnet

Returns true if the given object is an instance of Subnet. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

property cidrBlock

public cidrBlock: pulumi.Output<string>;

property description

public description: pulumi.Output<string | undefined>;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

Resource Switch

class Switch extends CustomResource

constructor

new Switch(name: string, args: SwitchArgs, opts?: pulumi.CustomResourceOptions)

Create a Switch resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SwitchState, opts?: pulumi.CustomResourceOptions): Switch

Get an existing Switch resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Switch

Returns true if the given object is an instance of Switch. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property availabilityZone

public availabilityZone: pulumi.Output<string>;

The AZ for the switch.

property cidrBlock

public cidrBlock: pulumi.Output<string>;

The CIDR block for the switch.

property description

public description: pulumi.Output<string | undefined>;

The switch description. Defaults to null.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the switch. Defaults to null.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcId

public vpcId: pulumi.Output<string>;

The VPC ID.

Functions

Function getCommonBandwidthPackages

getCommonBandwidthPackages(args?: GetCommonBandwidthPackagesArgs, opts?: pulumi.InvokeOptions): Promise<GetCommonBandwidthPackagesResult>

This data source provides a list of Common Bandwidth Packages owned by an Alibaba Cloud account.

NOTE: Available in 1.36.0+.

Example Usage

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

const fooCommonBandwithPackage = new alicloud.vpc.CommonBandwithPackage("foo", {
    bandwidth: 2,
    description: "tf-testAcc-CommonBandwidthPackage",
});
const fooCommonBandwidthPackages = fooCommonBandwithPackage.id.apply(id => alicloud.vpc.getCommonBandwidthPackages({
    ids: [id],
    nameRegex: "^tf-testAcc.*",
}, { async: true }));

Public ip addresses Block

The public ip addresses mapping supports the following:

  • ipAddress - The address of the EIP.
  • allocationId - The ID of the EIP instance.

Function getForwardEntries

getForwardEntries(args: GetForwardEntriesArgs, opts?: pulumi.InvokeOptions): Promise<GetForwardEntriesResult>

This data source provides a list of Forward Entries owned by an Alibaba Cloud account.

NOTE: Available in 1.37.0+.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "forward-entry-config-example-name";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultNetwork = new alicloud.vpc.Network("default", {
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/21",
    vpcId: defaultNetwork.id,
});
const defaultNatGateway = new alicloud.vpc.NatGateway("default", {
    specification: "Small",
    vpcId: defaultNetwork.id,
});
const defaultEip = new alicloud.ecs.Eip("default", {});
const defaultEipAssociation = new alicloud.ecs.EipAssociation("default", {
    allocationId: defaultEip.id,
    instanceId: defaultNatGateway.id,
});
const defaultForwardEntry = new alicloud.vpc.ForwardEntry("default", {
    externalIp: defaultEip.ipAddress,
    externalPort: "80",
    forwardTableId: defaultNatGateway.forwardTableIds,
    internalIp: "172.16.0.3",
    internalPort: "8080",
    ipProtocol: "tcp",
});
const defaultForwardEntries = defaultForwardEntry.forwardTableId.apply(forwardTableId => alicloud.vpc.getForwardEntries({
    forwardTableId: forwardTableId,
}, { async: true }));

Function getNatGateways

getNatGateways(args?: GetNatGatewaysArgs, opts?: pulumi.InvokeOptions): Promise<GetNatGatewaysResult>

This data source provides a list of Nat Gateways owned by an Alibaba Cloud account.

NOTE: Available in 1.37.0+.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "natGatewaysDatasource";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "172.16.0.0/12",
});
const fooNatGateway = new alicloud.vpc.NatGateway("foo", {
    specification: "Small",
    vpcId: fooNetwork.id,
});
const fooNatGateways = pulumi.all([fooNatGateway.id, fooNatGateway.name, fooNetwork.id]).apply(([fooNatGatewayId, name, fooNetworkId]) => alicloud.vpc.getNatGateways({
    ids: [fooNatGatewayId],
    nameRegex: name,
    vpcId: fooNetworkId,
}, { async: true }));

Function getNetworks

getNetworks(args?: GetNetworksArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworksResult>

This data source provides VPCs available to the user.

Example Usage

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

const vpcsDs = pulumi.output(alicloud.vpc.getNetworks({
    cidrBlock: "172.16.0.0/12",
    nameRegex: "^foo",
    status: "Available",
}, { async: true }));

export const firstVpcId = vpcsDs.vpcs[0].id;

Function getRouteEntries

getRouteEntries(args: GetRouteEntriesArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteEntriesResult>

This data source provides a list of Route Entries owned by an Alibaba Cloud account.

NOTE: Available in 1.37.0+.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "tf-testAccRouteEntryConfig";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const defaultInstanceTypes = defaultZones.apply(defaultZones => alicloud.ecs.getInstanceTypes({
    availabilityZone: defaultZones.zones[0].id,
    cpuCoreCount: 1,
    memorySize: 2,
}, { async: true }));
const defaultImages = pulumi.output(alicloud.ecs.getImages({
    mostRecent: true,
    nameRegex: "^ubuntu_18.*64",
    owners: "system",
}, { async: true }));
const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "10.1.0.0/21",
});
const fooSwitch = new alicloud.vpc.Switch("foo", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "10.1.1.0/24",
    vpcId: fooNetwork.id,
});
const tfTestFoo = new alicloud.ecs.SecurityGroup("tfTestFoo", {
    description: "foo",
    vpcId: fooNetwork.id,
});
const fooInstance = new alicloud.ecs.Instance("foo", {
    allocatePublicIp: true,
    imageId: defaultImages.images[0].id,
    // series III
    instanceChargeType: "PostPaid",
    instanceName: name,
    instanceType: defaultInstanceTypes.instanceTypes[0].id,
    internetChargeType: "PayByTraffic",
    internetMaxBandwidthOut: 5,
    // cn-beijing
    securityGroups: [tfTestFoo.id],
    systemDiskCategory: "cloudEfficiency",
    vswitchId: fooSwitch.id,
});
const fooRouteEntry = new alicloud.vpc.RouteEntry("foo", {
    destinationCidrblock: "172.11.1.1/32",
    nexthopId: fooInstance.id,
    nexthopType: "Instance",
    routeTableId: fooNetwork.routeTableId,
});
const ingress = new alicloud.ecs.SecurityGroupRule("ingress", {
    cidrIp: "0.0.0.0/0",
    ipProtocol: "tcp",
    nicType: "intranet",
    policy: "accept",
    portRange: "22/22",
    priority: 1,
    securityGroupId: tfTestFoo.id,
    type: "ingress",
});
const fooRouteEntries = fooRouteEntry.routeTableId.apply(routeTableId => alicloud.vpc.getRouteEntries({
    routeTableId: routeTableId,
}, { async: true }));

Function getRouterInterfaces

getRouterInterfaces(args?: GetRouterInterfacesArgs, opts?: pulumi.InvokeOptions): Promise<GetRouterInterfacesResult>

This data source provides information about router interfaces that connect VPCs together.

Example Usage

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

const routerInterfacesDs = pulumi.output(alicloud.vpc.getRouterInterfaces({
    nameRegex: "^testenv",
    status: "Active",
}, { async: true }));

export const firstRouterInterfaceId = routerInterfacesDs.interfaces[0].id;

Function getRouteTables

getRouteTables(args?: GetRouteTablesArgs, opts?: pulumi.InvokeOptions): Promise<GetRouteTablesResult>

This data source provides a list of Route Tables owned by an Alibaba Cloud account.

NOTE: Available in 1.36.0+.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "route-tables-datasource-example-name";

const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "172.16.0.0/12",
});
const fooRouteTable = new alicloud.vpc.RouteTable("foo", {
    description: name,
    vpcId: fooNetwork.id,
});
const fooRouteTables = fooRouteTable.id.apply(id => alicloud.vpc.getRouteTables({
    ids: [id],
}, { async: true }));

export const routeTableIds = fooRouteTables.ids!;

Function getSnatEntries

getSnatEntries(args: GetSnatEntriesArgs, opts?: pulumi.InvokeOptions): Promise<GetSnatEntriesResult>

This data source provides a list of Snat Entries owned by an Alibaba Cloud account.

NOTE: Available in 1.37.0+.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "snat-entry-example-name";

const defaultZones = pulumi.output(alicloud.getZones({
    availableResourceCreation: "VSwitch",
}, { async: true }));
const fooNetwork = new alicloud.vpc.Network("foo", {
    cidrBlock: "172.16.0.0/12",
});
const fooSwitch = new alicloud.vpc.Switch("foo", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/21",
    vpcId: fooNetwork.id,
});
const fooNatGateway = new alicloud.vpc.NatGateway("foo", {
    specification: "Small",
    vpcId: fooNetwork.id,
});
const fooEip = new alicloud.ecs.Eip("foo", {});
const fooEipAssociation = new alicloud.ecs.EipAssociation("foo", {
    allocationId: fooEip.id,
    instanceId: fooNatGateway.id,
});
const fooSnatEntry = new alicloud.vpc.SnatEntry("foo", {
    snatIp: fooEip.ipAddress,
    snatTableId: fooNatGateway.snatTableIds,
    sourceVswitchId: fooSwitch.id,
});
const fooSnatEntries = fooSnatEntry.snatTableId.apply(snatTableId => alicloud.vpc.getSnatEntries({
    snatTableId: snatTableId,
}, { async: true }));

Function getSslVpnClientCerts

getSslVpnClientCerts(args?: GetSslVpnClientCertsArgs, opts?: pulumi.InvokeOptions): Promise<GetSslVpnClientCertsResult>

The SSL-VPN client certificates data source lists lots of SSL-VPN client certificates resource information owned by an Alicloud account.

Example Usage

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

const foo = pulumi.output(alicloud.vpc.getSslVpnClientCerts({
    ids: ["fake-cert-id"],
    nameRegex: "^foo",
    outputFile: "/tmp/clientcert",
    sslVpnServerId: "fake-server-id",
}, { async: true }));

Function getSslVpnServers

getSslVpnServers(args?: GetSslVpnServersArgs, opts?: pulumi.InvokeOptions): Promise<GetSslVpnServersResult>

The SSL-VPN servers data source lists lots of SSL-VPN servers resource information owned by an Alicloud account.

Example Usage

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

const foo = pulumi.output(alicloud.vpc.getSslVpnServers({
    ids: ["fake-server-id"],
    nameRegex: "^foo",
    outputFile: "/tmp/sslserver",
    vpnGatewayId: "fake-vpn-id",
}, { async: true }));

Function getSwitches

getSwitches(args?: GetSwitchesArgs, opts?: pulumi.InvokeOptions): Promise<GetSwitchesResult>

This data source provides a list of VSwitches owned by an Alibaba Cloud account.

Example Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "vswitchDatasourceName";

const defaultZones = pulumi.output(alicloud.getZones({ async: true }));
const vpc = new alicloud.vpc.Network("vpc", {
    cidrBlock: "172.16.0.0/16",
});
const vswitch = new alicloud.vpc.Switch("vswitch", {
    availabilityZone: defaultZones.zones[0].id,
    cidrBlock: "172.16.0.0/24",
    vpcId: vpc.id,
});
const defaultSwitches = vswitch.name.apply(name => alicloud.vpc.getSwitches({
    nameRegex: name,
}, { async: true }));

Others

interface CommonBandwithPackageArgs

interface CommonBandwithPackageArgs

The set of arguments for constructing a CommonBandwithPackage resource.

property bandwidth

bandwidth: pulumi.Input<number>;

The bandwidth of the common bandwidth package, in Mbps.

property description

description?: pulumi.Input<string>;

The description of the common bandwidth package instance.

property internetChargeType

internetChargeType?: pulumi.Input<string>;

The billing method of the common bandwidth package. Valid values are “PayByBandwidth” and “PayBy95” and “PayByTraffic”. “PayBy95” is pay by classic 95th percentile pricing. International Account doesn’t supports “PayByBandwidth” and “PayBy95”. Default to “PayByTraffic”.

property name

name?: pulumi.Input<string>;

The name of the common bandwidth package.

property ratio

ratio?: pulumi.Input<number>;

Ratio of the common bandwidth package. It is valid when internetChargeType is PayBy95. Default to 100. Valid values: [10-100].

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the common bandwidth package belongs.

interface CommonBandwithPackageAttachmentArgs

interface CommonBandwithPackageAttachmentArgs

The set of arguments for constructing a CommonBandwithPackageAttachment resource.

property bandwidthPackageId

bandwidthPackageId: pulumi.Input<string>;

The bandwidthPackageId of the common bandwidth package attachment, the field can’t be changed.

property instanceId

instanceId: pulumi.Input<string>;

The instanceId of the common bandwidth package attachment, the field can’t be changed.

interface CommonBandwithPackageAttachmentState

interface CommonBandwithPackageAttachmentState

Input properties used for looking up and filtering CommonBandwithPackageAttachment resources.

property bandwidthPackageId

bandwidthPackageId?: pulumi.Input<string>;

The bandwidthPackageId of the common bandwidth package attachment, the field can’t be changed.

property instanceId

instanceId?: pulumi.Input<string>;

The instanceId of the common bandwidth package attachment, the field can’t be changed.

interface CommonBandwithPackageState

interface CommonBandwithPackageState

Input properties used for looking up and filtering CommonBandwithPackage resources.

property bandwidth

bandwidth?: pulumi.Input<number>;

The bandwidth of the common bandwidth package, in Mbps.

property description

description?: pulumi.Input<string>;

The description of the common bandwidth package instance.

property internetChargeType

internetChargeType?: pulumi.Input<string>;

The billing method of the common bandwidth package. Valid values are “PayByBandwidth” and “PayBy95” and “PayByTraffic”. “PayBy95” is pay by classic 95th percentile pricing. International Account doesn’t supports “PayByBandwidth” and “PayBy95”. Default to “PayByTraffic”.

property name

name?: pulumi.Input<string>;

The name of the common bandwidth package.

property ratio

ratio?: pulumi.Input<number>;

Ratio of the common bandwidth package. It is valid when internetChargeType is PayBy95. Default to 100. Valid values: [10-100].

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the common bandwidth package belongs.

interface ForwardEntryArgs

interface ForwardEntryArgs

The set of arguments for constructing a ForwardEntry resource.

property externalIp

externalIp: pulumi.Input<string>;

The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property externalPort

externalPort: pulumi.Input<string>;

The external port, valid value is 1~65535|any.

property forwardTableId

forwardTableId: pulumi.Input<string>;

The value can get from alicloud.vpc.NatGateway Attributes “forwardTableIds”.

property internalIp

internalIp: pulumi.Input<string>;

The internal ip, must a private ip.

property internalPort

internalPort: pulumi.Input<string>;

The internal port, valid value is 1~65535|any.

property ipProtocol

ipProtocol: pulumi.Input<string>;

The ip protocal, valid value is tcp|udp|any.

property name

name?: pulumi.Input<string>;

The name of forward entry.

interface ForwardEntryState

interface ForwardEntryState

Input properties used for looking up and filtering ForwardEntry resources.

property externalIp

externalIp?: pulumi.Input<string>;

The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property externalPort

externalPort?: pulumi.Input<string>;

The external port, valid value is 1~65535|any.

property forwardEntryId

forwardEntryId?: pulumi.Input<string>;

The id of the forward entry on the server.

property forwardTableId

forwardTableId?: pulumi.Input<string>;

The value can get from alicloud.vpc.NatGateway Attributes “forwardTableIds”.

property internalIp

internalIp?: pulumi.Input<string>;

The internal ip, must a private ip.

property internalPort

internalPort?: pulumi.Input<string>;

The internal port, valid value is 1~65535|any.

property ipProtocol

ipProtocol?: pulumi.Input<string>;

The ip protocal, valid value is tcp|udp|any.

property name

name?: pulumi.Input<string>;

The name of forward entry.

interface GetCommonBandwidthPackagesArgs

interface GetCommonBandwidthPackagesArgs

A collection of arguments for invoking getCommonBandwidthPackages.

property ids

ids?: string[];

A list of Common Bandwidth Packages IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by name.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which the common bandwidth package belongs.

interface GetCommonBandwidthPackagesResult

interface GetCommonBandwidthPackagesResult

A collection of values returned by getCommonBandwidthPackages.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

(Optional) A list of Common Bandwidth Packages IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of Common Bandwidth Packages names.

property outputFile

outputFile?: undefined | string;

property packages

packages: GetCommonBandwidthPackagesPackage[];

A list of Common Bandwidth Packages. Each element contains the following attributes:

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which the common bandwidth package belongs.

interface GetForwardEntriesArgs

interface GetForwardEntriesArgs

A collection of arguments for invoking getForwardEntries.

property externalIp

externalIp?: undefined | string;

The public IP address.

property forwardTableId

forwardTableId: string;

The ID of the Forward table.

property ids

ids?: string[];

A list of Forward Entries IDs.

property internalIp

internalIp?: undefined | string;

The private IP address.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by forward entry name.

property names

names?: string[];

A list of Forward Entries names.

property outputFile

outputFile?: undefined | string;

interface GetForwardEntriesResult

interface GetForwardEntriesResult

A collection of values returned by getForwardEntries.

property entries

entries: GetForwardEntriesEntry[];

A list of Forward Entries. Each element contains the following attributes:

property externalIp

externalIp?: undefined | string;

The public IP address.

property forwardTableId

forwardTableId: string;

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of Forward Entries IDs.

property internalIp

internalIp?: undefined | string;

The private IP address.

property nameRegex

nameRegex?: undefined | string;

property names

names?: string[];

A list of Forward Entries names.

property outputFile

outputFile?: undefined | string;

interface GetNatGatewaysArgs

interface GetNatGatewaysArgs

A collection of arguments for invoking getNatGateways.

property ids

ids?: string[];

A list of NAT gateways IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter nat gateways by name.

property outputFile

outputFile?: undefined | string;

property vpcId

vpcId?: undefined | string;

The ID of the VPC.

interface GetNatGatewaysResult

interface GetNatGatewaysResult

A collection of values returned by getNatGateways.

property gateways

gateways: GetNatGatewaysGateway[];

A list of Nat gateways. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

(Optional) A list of Nat gateways IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of Nat gateways names.

property outputFile

outputFile?: undefined | string;

property vpcId

vpcId?: undefined | string;

The ID of the VPC.

interface GetNetworksArgs

interface GetNetworksArgs

A collection of arguments for invoking getNetworks.

property cidrBlock

cidrBlock?: undefined | string;

Filter results by a specific CIDR block. For example: “172.16.0.0/12”.

property ids

ids?: string[];

A list of VPC IDs.

property isDefault

isDefault?: undefined | false | true;

Indicate whether the VPC is the default one in the specified region.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter VPCs by name.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which VPC belongs.

property status

status?: undefined | string;

Filter results by a specific status. Valid value are Pending and Available.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

property vswitchId

vswitchId?: undefined | string;

Filter results by the specified VSwitch.

interface GetNetworksResult

interface GetNetworksResult

A collection of values returned by getNetworks.

property cidrBlock

cidrBlock?: undefined | string;

CIDR block of the VPC.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of VPC IDs.

property isDefault

isDefault?: undefined | false | true;

Whether the VPC is the default VPC in the region.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of VPC names.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

property status

status?: undefined | string;

Status of the VPC.

property tags

tags?: undefined | {[key: string]: any};

A map of tags assigned to the VPC.

property vpcs

vpcs: GetNetworksVpc[];

A list of VPCs. Each element contains the following attributes:

property vswitchId

vswitchId?: undefined | string;

interface GetRouteEntriesArgs

interface GetRouteEntriesArgs

A collection of arguments for invoking getRouteEntries.

property cidrBlock

cidrBlock?: undefined | string;

The destination CIDR block of the route entry.

property instanceId

instanceId?: undefined | string;

The instance ID of the next hop.

property outputFile

outputFile?: undefined | string;

property routeTableId

routeTableId: string;

The ID of the router table to which the route entry belongs.

property type

type?: undefined | string;

The type of the route entry.

interface GetRouteEntriesResult

interface GetRouteEntriesResult

A collection of values returned by getRouteEntries.

property cidrBlock

cidrBlock?: undefined | string;

The destination CIDR block of the route entry.

property entries

entries: GetRouteEntriesEntry[];

A list of Route Entries. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

property instanceId

instanceId?: undefined | string;

The instance ID of the next hop.

property outputFile

outputFile?: undefined | string;

property routeTableId

routeTableId: string;

The ID of the router table to which the route entry belongs.

property type

type?: undefined | string;

The type of the route entry.

interface GetRouterInterfacesArgs

interface GetRouterInterfacesArgs

A collection of arguments for invoking getRouterInterfaces.

property ids

ids?: string[];

A list of router interface IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string used to filter by router interface name.

property oppositeInterfaceId

oppositeInterfaceId?: undefined | string;

ID of the peer router interface.

property oppositeInterfaceOwnerId

oppositeInterfaceOwnerId?: undefined | string;

Account ID of the owner of the peer router interface.

property outputFile

outputFile?: undefined | string;

property role

role?: undefined | string;

Role of the router interface. Valid values are InitiatingSide (connection initiator) and AcceptingSide (connection receiver). The value of this parameter must be InitiatingSide if the routerType is set to VBR.

property routerId

routerId?: undefined | string;

ID of the VRouter located in the local region.

property routerType

routerType?: undefined | string;

Router type in the local region. Valid values are VRouter and VBR (physical connection).

property specification

specification?: undefined | string;

Specification of the link, such as Small.1 (10Mb), Middle.1 (100Mb), Large.2 (2Gb), …etc.

property status

status?: undefined | string;

Expected status. Valid values are Active, Inactive and Idle.

interface GetRouterInterfacesResult

interface GetRouterInterfacesResult

A collection of values returned by getRouterInterfaces.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of router interface IDs.

property interfaces

interfaces: GetRouterInterfacesInterface[];

A list of router interfaces. Each element contains the following attributes:

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of router interface names.

property oppositeInterfaceId

oppositeInterfaceId?: undefined | string;

Peer router interface ID.

property oppositeInterfaceOwnerId

oppositeInterfaceOwnerId?: undefined | string;

Account ID of the owner of the peer router interface.

property outputFile

outputFile?: undefined | string;

property role

role?: undefined | string;

Router interface role. Possible values: InitiatingSide and AcceptingSide.

property routerId

routerId?: undefined | string;

ID of the VRouter located in the local region.

property routerType

routerType?: undefined | string;

Router type in the local region. Possible values: VRouter and VBR.

property specification

specification?: undefined | string;

Router interface specification. Possible values: Small.1, Middle.1, Large.2, …etc.

property status

status?: undefined | string;

Router interface status. Possible values: Active, Inactive and Idle.

interface GetRouteTablesArgs

interface GetRouteTablesArgs

A collection of arguments for invoking getRouteTables.

property ids

ids?: string[];

A list of Route Tables IDs.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter route tables by name.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which route tables belongs.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

property vpcId

vpcId?: undefined | string;

Vpc id of the route table.

interface GetRouteTablesResult

interface GetRouteTablesResult

A collection of values returned by getRouteTables.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

(Optional) A list of Route Tables IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of Route Tables names.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which route tables belongs.

property tables

tables: GetRouteTablesTable[];

A list of Route Tables. Each element contains the following attributes:

property tags

tags?: undefined | {[key: string]: any};

property vpcId

vpcId?: undefined | string;

interface GetSnatEntriesArgs

interface GetSnatEntriesArgs

A collection of arguments for invoking getSnatEntries.

property ids

ids?: string[];

A list of Snat Entries IDs.

property outputFile

outputFile?: undefined | string;

property snatIp

snatIp?: undefined | string;

The public IP of the Snat Entry.

property snatTableId

snatTableId: string;

The ID of the Snat table.

property sourceCidr

sourceCidr?: undefined | string;

The source CIDR block of the Snat Entry.

interface GetSnatEntriesResult

interface GetSnatEntriesResult

A collection of values returned by getSnatEntries.

property entries

entries: GetSnatEntriesEntry[];

A list of Snat Entries. Each element contains the following attributes:

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

(Optional) A list of Snat Entries IDs.

property outputFile

outputFile?: undefined | string;

property snatIp

snatIp?: undefined | string;

The public IP of the Snat Entry.

property snatTableId

snatTableId: string;

property sourceCidr

sourceCidr?: undefined | string;

The source CIDR block of the Snat Entry.

interface GetSslVpnClientCertsArgs

interface GetSslVpnClientCertsArgs

A collection of arguments for invoking getSslVpnClientCerts.

property ids

ids?: string[];

IDs of the SSL-VPN client certificates.

property nameRegex

nameRegex?: undefined | string;

A regex string of SSL-VPN client certificate name.

property outputFile

outputFile?: undefined | string;

Save the result to the file.

property sslVpnServerId

sslVpnServerId?: undefined | string;

Use the SSL-VPN server ID as the search key.

interface GetSslVpnClientCertsResult

interface GetSslVpnClientCertsResult

A collection of values returned by getSslVpnClientCerts.

property certs

certs: GetSslVpnClientCertsCert[];

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of SSL-VPN client cert IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of SSL-VPN client cert names.

property outputFile

outputFile?: undefined | string;

property sslVpnServerId

sslVpnServerId?: undefined | string;

ID of the SSL-VPN Server.

interface GetSslVpnServersArgs

interface GetSslVpnServersArgs

A collection of arguments for invoking getSslVpnServers.

property ids

ids?: string[];

IDs of the SSL-VPN servers.

property nameRegex

nameRegex?: undefined | string;

A regex string of SSL-VPN server name.

property outputFile

outputFile?: undefined | string;

Save the result to the file.

property vpnGatewayId

vpnGatewayId?: undefined | string;

Use the VPN gateway ID as the search key.

interface GetSslVpnServersResult

interface GetSslVpnServersResult

A collection of values returned by getSslVpnServers.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of SSL-VPN server IDs.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of SSL-VPN server names.

property outputFile

outputFile?: undefined | string;

property servers

servers: GetSslVpnServersServer[];

A list of SSL-VPN servers. Each element contains the following attributes:

property vpnGatewayId

vpnGatewayId?: undefined | string;

The ID of the VPN gateway instance.

interface GetSwitchesArgs

interface GetSwitchesArgs

A collection of arguments for invoking getSwitches.

property cidrBlock

cidrBlock?: undefined | string;

Filter results by a specific CIDR block. For example: “172.16.0.0/12”.

property ids

ids?: string[];

A list of VSwitch IDs.

property isDefault

isDefault?: undefined | false | true;

Indicate whether the VSwitch is created by the system.

property nameRegex

nameRegex?: undefined | string;

A regex string to filter results by name.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

The Id of resource group which VSWitch belongs.

property tags

tags?: undefined | {[key: string]: any};

A mapping of tags to assign to the resource.

property vpcId

vpcId?: undefined | string;

ID of the VPC that owns the VSwitch.

property zoneId

zoneId?: undefined | string;

The availability zone of the VSwitch.

interface GetSwitchesResult

interface GetSwitchesResult

A collection of values returned by getSwitches.

property cidrBlock

cidrBlock?: undefined | string;

CIDR block of the VSwitch.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property ids

ids: string[];

A list of VSwitch IDs.

property isDefault

isDefault?: undefined | false | true;

Whether the VSwitch is the default one in the region.

property nameRegex

nameRegex?: undefined | string;

property names

names: string[];

A list of VSwitch names.

property outputFile

outputFile?: undefined | string;

property resourceGroupId

resourceGroupId?: undefined | string;

property tags

tags?: undefined | {[key: string]: any};

property vpcId

vpcId?: undefined | string;

ID of the VPC that owns the VSwitch.

property vswitches

vswitches: GetSwitchesVswitch[];

A list of VSwitches. Each element contains the following attributes:

property zoneId

zoneId?: undefined | string;

ID of the availability zone where the VSwitch is located.

interface HAVipArgs

interface HAVipArgs

The set of arguments for constructing a HAVip resource.

property description

description?: pulumi.Input<string>;

The description of the HaVip instance.

property ipAddress

ipAddress?: pulumi.Input<string>;

The ip address of the HaVip. If not filled, the default will be assigned one from the vswitch.

property vswitchId

vswitchId: pulumi.Input<string>;

The vswitchId of the HaVip, the field can’t be changed.

interface HAVipAttachmentArgs

interface HAVipAttachmentArgs

The set of arguments for constructing a HAVipAttachment resource.

property havipId

havipId: pulumi.Input<string>;

The havipId of the havip attachment, the field can’t be changed.

property instanceId

instanceId: pulumi.Input<string>;

The instanceId of the havip attachment, the field can’t be changed.

interface HAVipAttachmentState

interface HAVipAttachmentState

Input properties used for looking up and filtering HAVipAttachment resources.

property havipId

havipId?: pulumi.Input<string>;

The havipId of the havip attachment, the field can’t be changed.

property instanceId

instanceId?: pulumi.Input<string>;

The instanceId of the havip attachment, the field can’t be changed.

interface HAVipState

interface HAVipState

Input properties used for looking up and filtering HAVip resources.

property description

description?: pulumi.Input<string>;

The description of the HaVip instance.

property ipAddress

ipAddress?: pulumi.Input<string>;

The ip address of the HaVip. If not filled, the default will be assigned one from the vswitch.

property vswitchId

vswitchId?: pulumi.Input<string>;

The vswitchId of the HaVip, the field can’t be changed.

interface NatGatewayArgs

interface NatGatewayArgs

The set of arguments for constructing a NatGateway resource.

property bandwidthPackages

bandwidthPackages?: pulumi.Input<pulumi.Input<NatGatewayBandwidthPackage>[]>;

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

property description

description?: pulumi.Input<string>;

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

property name

name?: pulumi.Input<string>;

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

property period

period?: pulumi.Input<number>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property spec

DEPRECATED Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.
spec?: pulumi.Input<string>;

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

property specification

specification?: pulumi.Input<string>;

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

property vpcId

vpcId: pulumi.Input<string>;

The VPC ID.

interface NatGatewayState

interface NatGatewayState

Input properties used for looking up and filtering NatGateway resources.

property bandwidthPackageIds

bandwidthPackageIds?: pulumi.Input<string>;

A list ID of the bandwidth packages, and split them with commas.

property bandwidthPackages

bandwidthPackages?: pulumi.Input<pulumi.Input<NatGatewayBandwidthPackage>[]>;

A list of bandwidth packages for the nat gatway. Only support nat gateway created before 00:00 on November 4, 2017. Available in v1.13.0+ and v1.7.1-.

property description

description?: pulumi.Input<string>;

Description of the nat gateway, This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Defaults to null.

property forwardTableIds

forwardTableIds?: pulumi.Input<string>;

The nat gateway will auto create a snap and forward item, the forwardTableIds is the created one.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

The billing method of the nat gateway. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”.

property name

name?: pulumi.Input<string>;

Name of the nat gateway. The value can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Defaults to null.

property period

period?: pulumi.Input<number>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property snatTableIds

snatTableIds?: pulumi.Input<string>;

The nat gateway will auto create a snap and forward item, the snatTableIds is the created one.

property spec

DEPRECATED Field 'spec' has been deprecated from provider version 1.7.1, and new field 'specification' can replace it.
spec?: pulumi.Input<string>;

It has been deprecated from provider version 1.7.1, and new field ‘specification’ can replace it.

property specification

specification?: pulumi.Input<string>;

The specification of the nat gateway. Valid values are Small, Middle and Large. Default to Small. Details refer to Nat Gateway Specification.

property vpcId

vpcId?: pulumi.Input<string>;

The VPC ID.

interface NetworkAclArgs

interface NetworkAclArgs

The set of arguments for constructing a NetworkAcl resource.

property description

description?: pulumi.Input<string>;

The description of the network acl instance.

property name

name?: pulumi.Input<string>;

The name of the network acl.

property vpcId

vpcId: pulumi.Input<string>;

The vpcId of the network acl, the field can’t be changed.

interface NetworkAclAttachmentArgs

interface NetworkAclAttachmentArgs

The set of arguments for constructing a NetworkAclAttachment resource.

property networkAclId

networkAclId: pulumi.Input<string>;

The id of the network acl, the field can’t be changed.

property resources

resources: pulumi.Input<pulumi.Input<NetworkAclAttachmentResource>[]>;

List of the resources associated with the network acl. The details see Block Resources.

interface NetworkAclAttachmentState

interface NetworkAclAttachmentState

Input properties used for looking up and filtering NetworkAclAttachment resources.

property networkAclId

networkAclId?: pulumi.Input<string>;

The id of the network acl, the field can’t be changed.

property resources

resources?: pulumi.Input<pulumi.Input<NetworkAclAttachmentResource>[]>;

List of the resources associated with the network acl. The details see Block Resources.

interface NetworkAclEntriesArgs

interface NetworkAclEntriesArgs

The set of arguments for constructing a NetworkAclEntries resource.

property egresses

egresses?: pulumi.Input<pulumi.Input<NetworkAclEntriesEgress>[]>;

List of the egress entries of the network acl. The order of the egress entries determines the priority. The details see Block Egress.

property ingresses

ingresses?: pulumi.Input<pulumi.Input<NetworkAclEntriesIngress>[]>;

List of the ingress entries of the network acl. The order of the ingress entries determines the priority. The details see Block Ingress.

property networkAclId

networkAclId: pulumi.Input<string>;

The id of the network acl, the field can’t be changed.

interface NetworkAclEntriesState

interface NetworkAclEntriesState

Input properties used for looking up and filtering NetworkAclEntries resources.

property egresses

egresses?: pulumi.Input<pulumi.Input<NetworkAclEntriesEgress>[]>;

List of the egress entries of the network acl. The order of the egress entries determines the priority. The details see Block Egress.

property ingresses

ingresses?: pulumi.Input<pulumi.Input<NetworkAclEntriesIngress>[]>;

List of the ingress entries of the network acl. The order of the ingress entries determines the priority. The details see Block Ingress.

property networkAclId

networkAclId?: pulumi.Input<string>;

The id of the network acl, the field can’t be changed.

interface NetworkAclState

interface NetworkAclState

Input properties used for looking up and filtering NetworkAcl resources.

property description

description?: pulumi.Input<string>;

The description of the network acl instance.

property name

name?: pulumi.Input<string>;

The name of the network acl.

property vpcId

vpcId?: pulumi.Input<string>;

The vpcId of the network acl, the field can’t be changed.

interface NetworkArgs

interface NetworkArgs

The set of arguments for constructing a Network resource.

property cidrBlock

cidrBlock: pulumi.Input<string>;

The CIDR block for the VPC.

property description

description?: pulumi.Input<string>;

The VPC description. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the VPC. Defaults to null.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the VPC belongs.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface NetworkInterfaceArgs

interface NetworkInterfaceArgs

The set of arguments for constructing a NetworkInterface resource.

property description

description?: pulumi.Input<string>;

Description of the ENI. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.

property name

name?: pulumi.Input<string>;

Name of the ENI. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”, “.”, “_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.

property privateIp

privateIp?: pulumi.Input<string>;

The primary private IP of the ENI.

property privateIps

privateIps?: pulumi.Input<pulumi.Input<string>[]>;

List of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property privateIpsCount

privateIpsCount?: pulumi.Input<number>;

Number of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the network interface belongs.

property securityGroups

securityGroups: pulumi.Input<pulumi.Input<string>[]>;

A list of security group ids to associate with.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vswitchId

vswitchId: pulumi.Input<string>;

The VSwitch to create the ENI in.

interface NetworkInterfaceAttachmentArgs

interface NetworkInterfaceAttachmentArgs

The set of arguments for constructing a NetworkInterfaceAttachment resource.

property instanceId

instanceId: pulumi.Input<string>;

The instance ID to attach.

property networkInterfaceId

networkInterfaceId: pulumi.Input<string>;

The ENI ID to attach.

interface NetworkInterfaceAttachmentState

interface NetworkInterfaceAttachmentState

Input properties used for looking up and filtering NetworkInterfaceAttachment resources.

property instanceId

instanceId?: pulumi.Input<string>;

The instance ID to attach.

property networkInterfaceId

networkInterfaceId?: pulumi.Input<string>;

The ENI ID to attach.

interface NetworkInterfaceState

interface NetworkInterfaceState

Input properties used for looking up and filtering NetworkInterface resources.

property description

description?: pulumi.Input<string>;

Description of the ENI. This description can have a string of 2 to 256 characters, It cannot begin with http:// or https://. Default value is null.

property mac

mac?: pulumi.Input<string>;

(Available in 1.54.0+) The MAC address of an ENI.

property name

name?: pulumi.Input<string>;

Name of the ENI. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”, “.”, “_“, and must not begin or end with a hyphen, and must not begin with http:// or https://. Default value is null.

property privateIp

privateIp?: pulumi.Input<string>;

The primary private IP of the ENI.

property privateIps

privateIps?: pulumi.Input<pulumi.Input<string>[]>;

List of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property privateIpsCount

privateIpsCount?: pulumi.Input<number>;

Number of secondary private IPs to assign to the ENI. Don’t use both privateIps and privateIpsCount in the same ENI resource block.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the network interface belongs.

property securityGroups

securityGroups?: pulumi.Input<pulumi.Input<string>[]>;

A list of security group ids to associate with.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vswitchId

vswitchId?: pulumi.Input<string>;

The VSwitch to create the ENI in.

interface NetworkState

interface NetworkState

Input properties used for looking up and filtering Network resources.

property cidrBlock

cidrBlock?: pulumi.Input<string>;

The CIDR block for the VPC.

property description

description?: pulumi.Input<string>;

The VPC description. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the VPC. Defaults to null.

property resourceGroupId

resourceGroupId?: pulumi.Input<string>;

The Id of resource group which the VPC belongs.

property routeTableId

routeTableId?: pulumi.Input<string>;

The route table ID of the router created by default on VPC creation.

property routerId

routerId?: pulumi.Input<string>;

The ID of the router created by default on VPC creation.

property routerTableId

routerTableId?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface RouteEntryArgs

interface RouteEntryArgs

The set of arguments for constructing a RouteEntry resource.

property destinationCidrblock

destinationCidrblock?: pulumi.Input<string>;

The RouteEntry’s target network segment.

property name

name?: pulumi.Input<string>;

The name of the route entry. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://.

property nexthopId

nexthopId?: pulumi.Input<string>;

The route entry’s next hop. ECS instance ID or VPC router interface ID.

property nexthopType

nexthopType?: pulumi.Input<string>;

The next hop type. Available values: - Instance (Default): Route the traffic destined for the destination CIDR block to an ECS instance in the VPC. - RouterInterface: Route the traffic destined for the destination CIDR block to a router interface. - VpnGateway: Route the traffic destined for the destination CIDR block to a VPN Gateway. - HaVip: Route the traffic destined for the destination CIDR block to an HAVIP. - NetworkInterface: Route the traffic destined for the destination CIDR block to an NetworkInterface. - NatGateway: Route the traffic destined for the destination CIDR block to an Nat Gateway.

property routeTableId

routeTableId: pulumi.Input<string>;

The ID of the route table.

property routerId

DEPRECATED Attribute router_id has been deprecated and suggest removing it from your template.
routerId?: pulumi.Input<string>;

This argument has beeb deprecated. Please use other arguments to launch a custom route entry.

interface RouteEntryState

interface RouteEntryState

Input properties used for looking up and filtering RouteEntry resources.

property destinationCidrblock

destinationCidrblock?: pulumi.Input<string>;

The RouteEntry’s target network segment.

property name

name?: pulumi.Input<string>;

The name of the route entry. This name can have a string of 2 to 128 characters, must contain only alphanumeric characters or hyphens, such as “-”,“.”,”_“, and must not begin or end with a hyphen, and must not begin with http:// or https://.

property nexthopId

nexthopId?: pulumi.Input<string>;

The route entry’s next hop. ECS instance ID or VPC router interface ID.

property nexthopType

nexthopType?: pulumi.Input<string>;

The next hop type. Available values: - Instance (Default): Route the traffic destined for the destination CIDR block to an ECS instance in the VPC. - RouterInterface: Route the traffic destined for the destination CIDR block to a router interface. - VpnGateway: Route the traffic destined for the destination CIDR block to a VPN Gateway. - HaVip: Route the traffic destined for the destination CIDR block to an HAVIP. - NetworkInterface: Route the traffic destined for the destination CIDR block to an NetworkInterface. - NatGateway: Route the traffic destined for the destination CIDR block to an Nat Gateway.

property routeTableId

routeTableId?: pulumi.Input<string>;

The ID of the route table.

property routerId

DEPRECATED Attribute router_id has been deprecated and suggest removing it from your template.
routerId?: pulumi.Input<string>;

This argument has beeb deprecated. Please use other arguments to launch a custom route entry.

interface RouterInterfaceArgs

interface RouterInterfaceArgs

The set of arguments for constructing a RouterInterface resource.

property description

description?: pulumi.Input<string>;

Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.

property healthCheckSourceIp

healthCheckSourceIp?: pulumi.Input<string>;

Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckTargetIp must be specified at the same time.

property healthCheckTargetIp

healthCheckTargetIp?: pulumi.Input<string>;

Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckSourceIp must be specified at the same time.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and oppositeRegion are the same.

property name

name?: pulumi.Input<string>;

Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.

property oppositeAccessPointId

DEPRECATED Attribute 'opposite_access_point_id' has been deprecated from version 1.11.0.
oppositeAccessPointId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0.

property oppositeRegion

oppositeRegion: pulumi.Input<string>;

The Region of peer side.

property period

period?: pulumi.Input<number>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property role

role: pulumi.Input<string>;

The role the router interface plays. Optional value: InitiatingSide, AcceptingSide.

property routerId

routerId: pulumi.Input<string>;

The Router ID.

property routerType

routerType: pulumi.Input<string>;

Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.

property specification

specification?: pulumi.Input<string>;

Specification of router interfaces. It is valid when role is InitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.

interface RouterInterfaceConnectionArgs

interface RouterInterfaceConnectionArgs

The set of arguments for constructing a RouterInterfaceConnection resource.

property interfaceId

interfaceId: pulumi.Input<string>;

One side router interface ID.

property oppositeInterfaceId

oppositeInterfaceId: pulumi.Input<string>;

Another side router interface ID. It must belong the specified “oppositeInterfaceOwnerId” account.

property oppositeInterfaceOwnerId

oppositeInterfaceOwnerId?: pulumi.Input<string>;

property oppositeRouterId

oppositeRouterId?: pulumi.Input<string>;

Another side router ID. It must belong the specified “oppositeInterfaceOwnerId” account. It is valid when field “oppositeInterfaceOwnerId” is specified.

property oppositeRouterType

oppositeRouterType?: pulumi.Input<string>;

Another side router Type. Optional value: VRouter, VBR. It is valid when field “oppositeInterfaceOwnerId” is specified.

interface RouterInterfaceConnectionState

interface RouterInterfaceConnectionState

Input properties used for looking up and filtering RouterInterfaceConnection resources.

property interfaceId

interfaceId?: pulumi.Input<string>;

One side router interface ID.

property oppositeInterfaceId

oppositeInterfaceId?: pulumi.Input<string>;

Another side router interface ID. It must belong the specified “oppositeInterfaceOwnerId” account.

property oppositeInterfaceOwnerId

oppositeInterfaceOwnerId?: pulumi.Input<string>;

property oppositeRouterId

oppositeRouterId?: pulumi.Input<string>;

Another side router ID. It must belong the specified “oppositeInterfaceOwnerId” account. It is valid when field “oppositeInterfaceOwnerId” is specified.

property oppositeRouterType

oppositeRouterType?: pulumi.Input<string>;

Another side router Type. Optional value: VRouter, VBR. It is valid when field “oppositeInterfaceOwnerId” is specified.

interface RouterInterfaceState

interface RouterInterfaceState

Input properties used for looking up and filtering RouterInterface resources.

property accessPointId

DEPRECATED Attribute 'opposite_access_point_id' has been deprecated from version 1.11.0.
accessPointId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0.

property description

description?: pulumi.Input<string>;

Description of the router interface. It can be 2-256 characters long or left blank. It cannot start with http:// and https://.

property healthCheckSourceIp

healthCheckSourceIp?: pulumi.Input<string>;

Used as the Packet Source IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckTargetIp must be specified at the same time.

property healthCheckTargetIp

healthCheckTargetIp?: pulumi.Input<string>;

Used as the Packet Target IP of health check for disaster recovery or ECMP. It is only valid when routerType is VBR. The IP must be an unused IP in the local VPC. It and healthCheckSourceIp must be specified at the same time.

property instanceChargeType

instanceChargeType?: pulumi.Input<string>;

The billing method of the router interface. Valid values are “PrePaid” and “PostPaid”. Default to “PostPaid”. Router Interface doesn’t support “PrePaid” when region and oppositeRegion are the same.

property name

name?: pulumi.Input<string>;

Name of the router interface. Length must be 2-80 characters long. Only Chinese characters, English letters, numbers, period (.), underline (_), or dash (-) are permitted. If it is not specified, the default value is interface ID. The name cannot start with http:// and https://.

property oppositeAccessPointId

DEPRECATED Attribute 'opposite_access_point_id' has been deprecated from version 1.11.0.
oppositeAccessPointId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0.

property oppositeInterfaceId

DEPRECATED Attribute 'opposite_interface_id' has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection's 'opposite_interface_id' instead.
oppositeInterfaceId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.

property oppositeInterfaceOwnerId

DEPRECATED Attribute 'opposite_interface_owner_id' has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection's 'opposite_interface_owner_id' instead.
oppositeInterfaceOwnerId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_interface_id’ instead.

property oppositeRegion

oppositeRegion?: pulumi.Input<string>;

The Region of peer side.

property oppositeRouterId

DEPRECATED Attribute 'opposite_router_id' has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection's 'opposite_router_id' instead.
oppositeRouterId?: pulumi.Input<string>;

It has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection’s ‘opposite_router_id’ instead.

property oppositeRouterType

DEPRECATED Attribute 'opposite_router_type' has been deprecated from version 1.11.0. Use resource alicloud_router_interface_connection's 'opposite_router_type' instead.
oppositeRouterType?: pulumi.Input<string>;

It has been deprecated from version 1.11.0. resource alicloud_router_interface_connection’s ‘opposite_router_type’ instead.

property period

period?: pulumi.Input<number>;

The duration that you will buy the resource, in month. It is valid when instanceChargeType is PrePaid. Default to 1. Valid values: [1-9, 12, 24, 36]. At present, the provider does not support modify “period” and you can do that via web console.

property role

role?: pulumi.Input<string>;

The role the router interface plays. Optional value: InitiatingSide, AcceptingSide.

property routerId

routerId?: pulumi.Input<string>;

The Router ID.

property routerType

routerType?: pulumi.Input<string>;

Router Type. Optional value: VRouter, VBR. Accepting side router interface type only be VRouter.

property specification

specification?: pulumi.Input<string>;

Specification of router interfaces. It is valid when role is InitiatingSide. Accepting side’s role is default to set as ‘Negative’. For more about the specification, refer to Router interface specification.

interface RouteTableArgs

interface RouteTableArgs

The set of arguments for constructing a RouteTable resource.

property description

description?: pulumi.Input<string>;

The description of the route table instance.

property name

name?: pulumi.Input<string>;

The name of the route table.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcId

vpcId: pulumi.Input<string>;

The vpcId of the route table, the field can’t be changed.

interface RouteTableAttachmentArgs

interface RouteTableAttachmentArgs

The set of arguments for constructing a RouteTableAttachment resource.

property routeTableId

routeTableId: pulumi.Input<string>;

The routeTableId of the route table attachment, the field can’t be changed.

property vswitchId

vswitchId: pulumi.Input<string>;

The vswitchId of the route table attachment, the field can’t be changed.

interface RouteTableAttachmentState

interface RouteTableAttachmentState

Input properties used for looking up and filtering RouteTableAttachment resources.

property routeTableId

routeTableId?: pulumi.Input<string>;

The routeTableId of the route table attachment, the field can’t be changed.

property vswitchId

vswitchId?: pulumi.Input<string>;

The vswitchId of the route table attachment, the field can’t be changed.

interface RouteTableState

interface RouteTableState

Input properties used for looking up and filtering RouteTable resources.

property description

description?: pulumi.Input<string>;

The description of the route table instance.

property name

name?: pulumi.Input<string>;

The name of the route table.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcId

vpcId?: pulumi.Input<string>;

The vpcId of the route table, the field can’t be changed.

interface SnatEntryArgs

interface SnatEntryArgs

The set of arguments for constructing a SnatEntry resource.

property snatEntryName

snatEntryName?: pulumi.Input<string>;

The name of snat entry.

property snatIp

snatIp: pulumi.Input<string>;

The SNAT ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property snatTableId

snatTableId: pulumi.Input<string>;

The value can get from alicloud.vpc.NatGateway Attributes “snatTableIds”.

property sourceCidr

sourceCidr?: pulumi.Input<string>;

The private network segment of Ecs. This parameter and the sourceVswitchId parameter are mutually exclusive and cannot appear at the same time.

property sourceVswitchId

sourceVswitchId?: pulumi.Input<string>;

The vswitch ID.

interface SnatEntryState

interface SnatEntryState

Input properties used for looking up and filtering SnatEntry resources.

property snatEntryId

snatEntryId?: pulumi.Input<string>;

The id of the snat entry on the server.

property snatEntryName

snatEntryName?: pulumi.Input<string>;

The name of snat entry.

property snatIp

snatIp?: pulumi.Input<string>;

The SNAT ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidthPackages.

property snatTableId

snatTableId?: pulumi.Input<string>;

The value can get from alicloud.vpc.NatGateway Attributes “snatTableIds”.

property sourceCidr

sourceCidr?: pulumi.Input<string>;

The private network segment of Ecs. This parameter and the sourceVswitchId parameter are mutually exclusive and cannot appear at the same time.

property sourceVswitchId

sourceVswitchId?: pulumi.Input<string>;

The vswitch ID.

interface SubnetArgs

interface SubnetArgs

The set of arguments for constructing a Subnet resource.

property availabilityZone

availabilityZone: pulumi.Input<string>;

property cidrBlock

cidrBlock: pulumi.Input<string>;

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vpcId

vpcId: pulumi.Input<string>;

interface SubnetState

interface SubnetState

Input properties used for looking up and filtering Subnet resources.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

property cidrBlock

cidrBlock?: pulumi.Input<string>;

property description

description?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property vpcId

vpcId?: pulumi.Input<string>;

interface SwitchArgs

interface SwitchArgs

The set of arguments for constructing a Switch resource.

property availabilityZone

availabilityZone: pulumi.Input<string>;

The AZ for the switch.

property cidrBlock

cidrBlock: pulumi.Input<string>;

The CIDR block for the switch.

property description

description?: pulumi.Input<string>;

The switch description. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the switch. Defaults to null.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcId

vpcId: pulumi.Input<string>;

The VPC ID.

interface SwitchState

interface SwitchState

Input properties used for looking up and filtering Switch resources.

property availabilityZone

availabilityZone?: pulumi.Input<string>;

The AZ for the switch.

property cidrBlock

cidrBlock?: pulumi.Input<string>;

The CIDR block for the switch.

property description

description?: pulumi.Input<string>;

The switch description. Defaults to null.

property name

name?: pulumi.Input<string>;

The name of the switch. Defaults to null.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property vpcId

vpcId?: pulumi.Input<string>;

The VPC ID.