1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. vpc
  5. ForwardEntry
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.vpc.ForwardEntry

Explore with Pulumi AI

Provides a forward resource.

NOTE: Available since v1.40.0.

Example Usage

Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "forward-entry-example-name";
const _default = alicloud.getZones({
    availableResourceCreation: "VSwitch",
});
const defaultNetwork = new alicloud.vpc.Network("default", {
    vpcName: name,
    cidrBlock: "172.16.0.0/12",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vpcId: defaultNetwork.id,
    cidrBlock: "172.16.0.0/21",
    zoneId: _default.then(_default => _default.zones?.[0]?.id),
    vswitchName: name,
});
const defaultNatGateway = new alicloud.vpc.NatGateway("default", {
    vpcId: defaultNetwork.id,
    internetChargeType: "PayByLcu",
    natGatewayName: name,
    natType: "Enhanced",
    vswitchId: defaultSwitch.id,
});
const defaultEipAddress = new alicloud.ecs.EipAddress("default", {addressName: name});
const defaultEipAssociation = new alicloud.ecs.EipAssociation("default", {
    allocationId: defaultEipAddress.id,
    instanceId: defaultNatGateway.id,
});
const defaultForwardEntry = new alicloud.vpc.ForwardEntry("default", {
    forwardTableId: defaultNatGateway.forwardTableIds,
    externalIp: defaultEipAddress.ipAddress,
    externalPort: "80",
    ipProtocol: "tcp",
    internalIp: "172.16.0.3",
    internalPort: "8080",
});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "forward-entry-example-name"
default = alicloud.get_zones(available_resource_creation="VSwitch")
default_network = alicloud.vpc.Network("default",
    vpc_name=name,
    cidr_block="172.16.0.0/12")
default_switch = alicloud.vpc.Switch("default",
    vpc_id=default_network.id,
    cidr_block="172.16.0.0/21",
    zone_id=default.zones[0].id,
    vswitch_name=name)
default_nat_gateway = alicloud.vpc.NatGateway("default",
    vpc_id=default_network.id,
    internet_charge_type="PayByLcu",
    nat_gateway_name=name,
    nat_type="Enhanced",
    vswitch_id=default_switch.id)
default_eip_address = alicloud.ecs.EipAddress("default", address_name=name)
default_eip_association = alicloud.ecs.EipAssociation("default",
    allocation_id=default_eip_address.id,
    instance_id=default_nat_gateway.id)
default_forward_entry = alicloud.vpc.ForwardEntry("default",
    forward_table_id=default_nat_gateway.forward_table_ids,
    external_ip=default_eip_address.ip_address,
    external_port="80",
    ip_protocol="tcp",
    internal_ip="172.16.0.3",
    internal_port="8080")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "forward-entry-example-name"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("VSwitch"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String(name),
			CidrBlock: pulumi.String("172.16.0.0/12"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VpcId:       defaultNetwork.ID(),
			CidrBlock:   pulumi.String("172.16.0.0/21"),
			ZoneId:      pulumi.String(_default.Zones[0].Id),
			VswitchName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		defaultNatGateway, err := vpc.NewNatGateway(ctx, "default", &vpc.NatGatewayArgs{
			VpcId:              defaultNetwork.ID(),
			InternetChargeType: pulumi.String("PayByLcu"),
			NatGatewayName:     pulumi.String(name),
			NatType:            pulumi.String("Enhanced"),
			VswitchId:          defaultSwitch.ID(),
		})
		if err != nil {
			return err
		}
		defaultEipAddress, err := ecs.NewEipAddress(ctx, "default", &ecs.EipAddressArgs{
			AddressName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = ecs.NewEipAssociation(ctx, "default", &ecs.EipAssociationArgs{
			AllocationId: defaultEipAddress.ID(),
			InstanceId:   defaultNatGateway.ID(),
		})
		if err != nil {
			return err
		}
		_, err = vpc.NewForwardEntry(ctx, "default", &vpc.ForwardEntryArgs{
			ForwardTableId: defaultNatGateway.ForwardTableIds,
			ExternalIp:     defaultEipAddress.IpAddress,
			ExternalPort:   pulumi.String("80"),
			IpProtocol:     pulumi.String("tcp"),
			InternalIp:     pulumi.String("172.16.0.3"),
			InternalPort:   pulumi.String("8080"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "forward-entry-example-name";
    var @default = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "VSwitch",
    });

    var defaultNetwork = new AliCloud.Vpc.Network("default", new()
    {
        VpcName = name,
        CidrBlock = "172.16.0.0/12",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VpcId = defaultNetwork.Id,
        CidrBlock = "172.16.0.0/21",
        ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
        VswitchName = name,
    });

    var defaultNatGateway = new AliCloud.Vpc.NatGateway("default", new()
    {
        VpcId = defaultNetwork.Id,
        InternetChargeType = "PayByLcu",
        NatGatewayName = name,
        NatType = "Enhanced",
        VswitchId = defaultSwitch.Id,
    });

    var defaultEipAddress = new AliCloud.Ecs.EipAddress("default", new()
    {
        AddressName = name,
    });

    var defaultEipAssociation = new AliCloud.Ecs.EipAssociation("default", new()
    {
        AllocationId = defaultEipAddress.Id,
        InstanceId = defaultNatGateway.Id,
    });

    var defaultForwardEntry = new AliCloud.Vpc.ForwardEntry("default", new()
    {
        ForwardTableId = defaultNatGateway.ForwardTableIds,
        ExternalIp = defaultEipAddress.IpAddress,
        ExternalPort = "80",
        IpProtocol = "tcp",
        InternalIp = "172.16.0.3",
        InternalPort = "8080",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.vpc.NatGateway;
import com.pulumi.alicloud.vpc.NatGatewayArgs;
import com.pulumi.alicloud.ecs.EipAddress;
import com.pulumi.alicloud.ecs.EipAddressArgs;
import com.pulumi.alicloud.ecs.EipAssociation;
import com.pulumi.alicloud.ecs.EipAssociationArgs;
import com.pulumi.alicloud.vpc.ForwardEntry;
import com.pulumi.alicloud.vpc.ForwardEntryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("forward-entry-example-name");
        final var default = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("VSwitch")
            .build());

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName(name)
            .cidrBlock("172.16.0.0/12")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vpcId(defaultNetwork.id())
            .cidrBlock("172.16.0.0/21")
            .zoneId(default_.zones()[0].id())
            .vswitchName(name)
            .build());

        var defaultNatGateway = new NatGateway("defaultNatGateway", NatGatewayArgs.builder()
            .vpcId(defaultNetwork.id())
            .internetChargeType("PayByLcu")
            .natGatewayName(name)
            .natType("Enhanced")
            .vswitchId(defaultSwitch.id())
            .build());

        var defaultEipAddress = new EipAddress("defaultEipAddress", EipAddressArgs.builder()
            .addressName(name)
            .build());

        var defaultEipAssociation = new EipAssociation("defaultEipAssociation", EipAssociationArgs.builder()
            .allocationId(defaultEipAddress.id())
            .instanceId(defaultNatGateway.id())
            .build());

        var defaultForwardEntry = new ForwardEntry("defaultForwardEntry", ForwardEntryArgs.builder()
            .forwardTableId(defaultNatGateway.forwardTableIds())
            .externalIp(defaultEipAddress.ipAddress())
            .externalPort("80")
            .ipProtocol("tcp")
            .internalIp("172.16.0.3")
            .internalPort("8080")
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: forward-entry-example-name
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    name: default
    properties:
      vpcName: ${name}
      cidrBlock: 172.16.0.0/12
  defaultSwitch:
    type: alicloud:vpc:Switch
    name: default
    properties:
      vpcId: ${defaultNetwork.id}
      cidrBlock: 172.16.0.0/21
      zoneId: ${default.zones[0].id}
      vswitchName: ${name}
  defaultNatGateway:
    type: alicloud:vpc:NatGateway
    name: default
    properties:
      vpcId: ${defaultNetwork.id}
      internetChargeType: PayByLcu
      natGatewayName: ${name}
      natType: Enhanced
      vswitchId: ${defaultSwitch.id}
  defaultEipAddress:
    type: alicloud:ecs:EipAddress
    name: default
    properties:
      addressName: ${name}
  defaultEipAssociation:
    type: alicloud:ecs:EipAssociation
    name: default
    properties:
      allocationId: ${defaultEipAddress.id}
      instanceId: ${defaultNatGateway.id}
  defaultForwardEntry:
    type: alicloud:vpc:ForwardEntry
    name: default
    properties:
      forwardTableId: ${defaultNatGateway.forwardTableIds}
      externalIp: ${defaultEipAddress.ipAddress}
      externalPort: '80'
      ipProtocol: tcp
      internalIp: 172.16.0.3
      internalPort: '8080'
variables:
  default:
    fn::invoke:
      function: alicloud:getZones
      arguments:
        availableResourceCreation: VSwitch
Copy

Create ForwardEntry Resource

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

Constructor syntax

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

@overload
def ForwardEntry(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 external_ip: Optional[str] = None,
                 external_port: Optional[str] = None,
                 forward_table_id: Optional[str] = None,
                 internal_ip: Optional[str] = None,
                 internal_port: Optional[str] = None,
                 ip_protocol: Optional[str] = None,
                 forward_entry_name: Optional[str] = None,
                 name: Optional[str] = None,
                 port_break: Optional[bool] = None)
func NewForwardEntry(ctx *Context, name string, args ForwardEntryArgs, opts ...ResourceOption) (*ForwardEntry, error)
public ForwardEntry(string name, ForwardEntryArgs args, CustomResourceOptions? opts = null)
public ForwardEntry(String name, ForwardEntryArgs args)
public ForwardEntry(String name, ForwardEntryArgs args, CustomResourceOptions options)
type: alicloud:vpc:ForwardEntry
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ForwardEntryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ForwardEntryArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ForwardEntryArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ForwardEntryArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ForwardEntryArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var forwardEntryResource = new AliCloud.Vpc.ForwardEntry("forwardEntryResource", new()
{
    ExternalIp = "string",
    ExternalPort = "string",
    ForwardTableId = "string",
    InternalIp = "string",
    InternalPort = "string",
    IpProtocol = "string",
    ForwardEntryName = "string",
    PortBreak = false,
});
Copy
example, err := vpc.NewForwardEntry(ctx, "forwardEntryResource", &vpc.ForwardEntryArgs{
	ExternalIp:       pulumi.String("string"),
	ExternalPort:     pulumi.String("string"),
	ForwardTableId:   pulumi.String("string"),
	InternalIp:       pulumi.String("string"),
	InternalPort:     pulumi.String("string"),
	IpProtocol:       pulumi.String("string"),
	ForwardEntryName: pulumi.String("string"),
	PortBreak:        pulumi.Bool(false),
})
Copy
var forwardEntryResource = new ForwardEntry("forwardEntryResource", ForwardEntryArgs.builder()
    .externalIp("string")
    .externalPort("string")
    .forwardTableId("string")
    .internalIp("string")
    .internalPort("string")
    .ipProtocol("string")
    .forwardEntryName("string")
    .portBreak(false)
    .build());
Copy
forward_entry_resource = alicloud.vpc.ForwardEntry("forwardEntryResource",
    external_ip="string",
    external_port="string",
    forward_table_id="string",
    internal_ip="string",
    internal_port="string",
    ip_protocol="string",
    forward_entry_name="string",
    port_break=False)
Copy
const forwardEntryResource = new alicloud.vpc.ForwardEntry("forwardEntryResource", {
    externalIp: "string",
    externalPort: "string",
    forwardTableId: "string",
    internalIp: "string",
    internalPort: "string",
    ipProtocol: "string",
    forwardEntryName: "string",
    portBreak: false,
});
Copy
type: alicloud:vpc:ForwardEntry
properties:
    externalIp: string
    externalPort: string
    forwardEntryName: string
    forwardTableId: string
    internalIp: string
    internalPort: string
    ipProtocol: string
    portBreak: false
Copy

ForwardEntry Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ForwardEntry resource accepts the following input properties:

ExternalIp This property is required. string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
ExternalPort This property is required. string
The external port, valid value is 1~65535|any.
ForwardTableId
This property is required.
Changes to this property will trigger replacement.
string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
InternalIp This property is required. string
The internal ip, must a private ip.
InternalPort This property is required. string
The internal port, valid value is 1~65535|any.
IpProtocol This property is required. string
The ip protocol, valid value is tcp|udp|any.
ForwardEntryName string
The name of forward entry.
Name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

PortBreak bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

ExternalIp This property is required. string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
ExternalPort This property is required. string
The external port, valid value is 1~65535|any.
ForwardTableId
This property is required.
Changes to this property will trigger replacement.
string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
InternalIp This property is required. string
The internal ip, must a private ip.
InternalPort This property is required. string
The internal port, valid value is 1~65535|any.
IpProtocol This property is required. string
The ip protocol, valid value is tcp|udp|any.
ForwardEntryName string
The name of forward entry.
Name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

PortBreak bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

externalIp This property is required. String
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort This property is required. String
The external port, valid value is 1~65535|any.
forwardTableId
This property is required.
Changes to this property will trigger replacement.
String
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp This property is required. String
The internal ip, must a private ip.
internalPort This property is required. String
The internal port, valid value is 1~65535|any.
ipProtocol This property is required. String
The ip protocol, valid value is tcp|udp|any.
forwardEntryName String
The name of forward entry.
name String
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak Boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

externalIp This property is required. string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort This property is required. string
The external port, valid value is 1~65535|any.
forwardTableId
This property is required.
Changes to this property will trigger replacement.
string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp This property is required. string
The internal ip, must a private ip.
internalPort This property is required. string
The internal port, valid value is 1~65535|any.
ipProtocol This property is required. string
The ip protocol, valid value is tcp|udp|any.
forwardEntryName string
The name of forward entry.
name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

external_ip This property is required. str
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
external_port This property is required. str
The external port, valid value is 1~65535|any.
forward_table_id
This property is required.
Changes to this property will trigger replacement.
str
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internal_ip This property is required. str
The internal ip, must a private ip.
internal_port This property is required. str
The internal port, valid value is 1~65535|any.
ip_protocol This property is required. str
The ip protocol, valid value is tcp|udp|any.
forward_entry_name str
The name of forward entry.
name str
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

port_break bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

externalIp This property is required. String
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort This property is required. String
The external port, valid value is 1~65535|any.
forwardTableId
This property is required.
Changes to this property will trigger replacement.
String
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp This property is required. String
The internal ip, must a private ip.
internalPort This property is required. String
The internal port, valid value is 1~65535|any.
ipProtocol This property is required. String
The ip protocol, valid value is tcp|udp|any.
forwardEntryName String
The name of forward entry.
name String
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak Boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

Outputs

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

ForwardEntryId string
The id of the forward entry on the server.
Id string
The provider-assigned unique ID for this managed resource.
Status string
(Available since 1.119.1+) The status of forward entry.
ForwardEntryId string
The id of the forward entry on the server.
Id string
The provider-assigned unique ID for this managed resource.
Status string
(Available since 1.119.1+) The status of forward entry.
forwardEntryId String
The id of the forward entry on the server.
id String
The provider-assigned unique ID for this managed resource.
status String
(Available since 1.119.1+) The status of forward entry.
forwardEntryId string
The id of the forward entry on the server.
id string
The provider-assigned unique ID for this managed resource.
status string
(Available since 1.119.1+) The status of forward entry.
forward_entry_id str
The id of the forward entry on the server.
id str
The provider-assigned unique ID for this managed resource.
status str
(Available since 1.119.1+) The status of forward entry.
forwardEntryId String
The id of the forward entry on the server.
id String
The provider-assigned unique ID for this managed resource.
status String
(Available since 1.119.1+) The status of forward entry.

Look up Existing ForwardEntry Resource

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

public static get(name: string, id: Input<ID>, state?: ForwardEntryState, opts?: CustomResourceOptions): ForwardEntry
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_ip: Optional[str] = None,
        external_port: Optional[str] = None,
        forward_entry_id: Optional[str] = None,
        forward_entry_name: Optional[str] = None,
        forward_table_id: Optional[str] = None,
        internal_ip: Optional[str] = None,
        internal_port: Optional[str] = None,
        ip_protocol: Optional[str] = None,
        name: Optional[str] = None,
        port_break: Optional[bool] = None,
        status: Optional[str] = None) -> ForwardEntry
func GetForwardEntry(ctx *Context, name string, id IDInput, state *ForwardEntryState, opts ...ResourceOption) (*ForwardEntry, error)
public static ForwardEntry Get(string name, Input<string> id, ForwardEntryState? state, CustomResourceOptions? opts = null)
public static ForwardEntry get(String name, Output<String> id, ForwardEntryState state, CustomResourceOptions options)
resources:  _:    type: alicloud:vpc:ForwardEntry    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ExternalIp string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
ExternalPort string
The external port, valid value is 1~65535|any.
ForwardEntryId string
The id of the forward entry on the server.
ForwardEntryName string
The name of forward entry.
ForwardTableId Changes to this property will trigger replacement. string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
InternalIp string
The internal ip, must a private ip.
InternalPort string
The internal port, valid value is 1~65535|any.
IpProtocol string
The ip protocol, valid value is tcp|udp|any.
Name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

PortBreak bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

Status string
(Available since 1.119.1+) The status of forward entry.
ExternalIp string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
ExternalPort string
The external port, valid value is 1~65535|any.
ForwardEntryId string
The id of the forward entry on the server.
ForwardEntryName string
The name of forward entry.
ForwardTableId Changes to this property will trigger replacement. string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
InternalIp string
The internal ip, must a private ip.
InternalPort string
The internal port, valid value is 1~65535|any.
IpProtocol string
The ip protocol, valid value is tcp|udp|any.
Name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

PortBreak bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

Status string
(Available since 1.119.1+) The status of forward entry.
externalIp String
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort String
The external port, valid value is 1~65535|any.
forwardEntryId String
The id of the forward entry on the server.
forwardEntryName String
The name of forward entry.
forwardTableId Changes to this property will trigger replacement. String
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp String
The internal ip, must a private ip.
internalPort String
The internal port, valid value is 1~65535|any.
ipProtocol String
The ip protocol, valid value is tcp|udp|any.
name String
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak Boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

status String
(Available since 1.119.1+) The status of forward entry.
externalIp string
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort string
The external port, valid value is 1~65535|any.
forwardEntryId string
The id of the forward entry on the server.
forwardEntryName string
The name of forward entry.
forwardTableId Changes to this property will trigger replacement. string
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp string
The internal ip, must a private ip.
internalPort string
The internal port, valid value is 1~65535|any.
ipProtocol string
The ip protocol, valid value is tcp|udp|any.
name string
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

status string
(Available since 1.119.1+) The status of forward entry.
external_ip str
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
external_port str
The external port, valid value is 1~65535|any.
forward_entry_id str
The id of the forward entry on the server.
forward_entry_name str
The name of forward entry.
forward_table_id Changes to this property will trigger replacement. str
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internal_ip str
The internal ip, must a private ip.
internal_port str
The internal port, valid value is 1~65535|any.
ip_protocol str
The ip protocol, valid value is tcp|udp|any.
name str
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

port_break bool

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

status str
(Available since 1.119.1+) The status of forward entry.
externalIp String
The external ip address, the ip must along bandwidth package public ip which alicloud.vpc.NatGateway argument bandwidth_packages.
externalPort String
The external port, valid value is 1~65535|any.
forwardEntryId String
The id of the forward entry on the server.
forwardEntryName String
The name of forward entry.
forwardTableId Changes to this property will trigger replacement. String
The value can get from alicloud.vpc.NatGateway Attributes "forward_table_ids".
internalIp String
The internal ip, must a private ip.
internalPort String
The internal port, valid value is 1~65535|any.
ipProtocol String
The ip protocol, valid value is tcp|udp|any.
name String
Field name has been deprecated from provider version 1.119.1. New field forward_entry_name instead.

Deprecated: Field 'name' has been deprecated from provider version 1.119.1. New field 'forward_entry_name' instead.

portBreak Boolean

Specifies whether to remove limits on the port range. Default value is false.

NOTE: A SNAT entry and a DNAT entry may use the same public IP address. If you want to specify a port number greater than 1024 in this case, set port_break to true.

status String
(Available since 1.119.1+) The status of forward entry.

Import

Forward Entry can be imported using the id, e.g.

$ pulumi import alicloud:vpc/forwardEntry:ForwardEntry foo ftb-1aece3:fwd-232ce2
Copy

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

Package Details

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