Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. DcIpPortForwarding
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.DcIpPortForwarding

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

Manages a direct connect ip port forwarding resource.

Note: This resource requires Sprut SDN to be enabled in your project.

New since v0.8.0.

Example Usage

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

const dcIpPortForwarding = new vkcs.DcIpPortForwarding("dcIpPortForwarding", {
    dcInterfaceId: vkcs_dc_interface.dc_interface.id,
    description: "tf-example-description",
    protocol: "udp",
    toDestination: "172.17.20.30",
});
Copy
import pulumi
import pulumi_vkcs as vkcs

dc_ip_port_forwarding = vkcs.DcIpPortForwarding("dcIpPortForwarding",
    dc_interface_id=vkcs_dc_interface["dc_interface"]["id"],
    description="tf-example-description",
    protocol="udp",
    to_destination="172.17.20.30")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewDcIpPortForwarding(ctx, "dcIpPortForwarding", &vkcs.DcIpPortForwardingArgs{
			DcInterfaceId: pulumi.Any(vkcs_dc_interface.Dc_interface.Id),
			Description:   pulumi.String("tf-example-description"),
			Protocol:      pulumi.String("udp"),
			ToDestination: pulumi.String("172.17.20.30"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var dcIpPortForwarding = new Vkcs.DcIpPortForwarding("dcIpPortForwarding", new()
    {
        DcInterfaceId = vkcs_dc_interface.Dc_interface.Id,
        Description = "tf-example-description",
        Protocol = "udp",
        ToDestination = "172.17.20.30",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.DcIpPortForwarding;
import com.pulumi.vkcs.DcIpPortForwardingArgs;
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) {
        var dcIpPortForwarding = new DcIpPortForwarding("dcIpPortForwarding", DcIpPortForwardingArgs.builder()
            .dcInterfaceId(vkcs_dc_interface.dc_interface().id())
            .description("tf-example-description")
            .protocol("udp")
            .toDestination("172.17.20.30")
            .build());

    }
}
Copy
resources:
  dcIpPortForwarding:
    type: vkcs:DcIpPortForwarding
    properties:
      dcInterfaceId: ${vkcs_dc_interface.dc_interface.id}
      description: tf-example-description
      protocol: udp
      toDestination: 172.17.20.30
Copy

Create DcIpPortForwarding Resource

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

Constructor syntax

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

@overload
def DcIpPortForwarding(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       dc_interface_id: Optional[str] = None,
                       protocol: Optional[str] = None,
                       to_destination: Optional[str] = None,
                       description: Optional[str] = None,
                       destination: Optional[str] = None,
                       name: Optional[str] = None,
                       port: Optional[float] = None,
                       region: Optional[str] = None,
                       source: Optional[str] = None,
                       to_port: Optional[float] = None)
func NewDcIpPortForwarding(ctx *Context, name string, args DcIpPortForwardingArgs, opts ...ResourceOption) (*DcIpPortForwarding, error)
public DcIpPortForwarding(string name, DcIpPortForwardingArgs args, CustomResourceOptions? opts = null)
public DcIpPortForwarding(String name, DcIpPortForwardingArgs args)
public DcIpPortForwarding(String name, DcIpPortForwardingArgs args, CustomResourceOptions options)

type: vkcs:DcIpPortForwarding
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. DcIpPortForwardingArgs
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. DcIpPortForwardingArgs
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. DcIpPortForwardingArgs
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. DcIpPortForwardingArgs
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. DcIpPortForwardingArgs
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 dcIpPortForwardingResource = new Vkcs.DcIpPortForwarding("dcIpPortForwardingResource", new()
{
    DcInterfaceId = "string",
    Protocol = "string",
    ToDestination = "string",
    Description = "string",
    Destination = "string",
    Name = "string",
    Port = 0,
    Region = "string",
    Source = "string",
    ToPort = 0,
});
Copy
example, err := vkcs.NewDcIpPortForwarding(ctx, "dcIpPortForwardingResource", &vkcs.DcIpPortForwardingArgs{
	DcInterfaceId: pulumi.String("string"),
	Protocol:      pulumi.String("string"),
	ToDestination: pulumi.String("string"),
	Description:   pulumi.String("string"),
	Destination:   pulumi.String("string"),
	Name:          pulumi.String("string"),
	Port:          pulumi.Float64(0),
	Region:        pulumi.String("string"),
	Source:        pulumi.String("string"),
	ToPort:        pulumi.Float64(0),
})
Copy
var dcIpPortForwardingResource = new DcIpPortForwarding("dcIpPortForwardingResource", DcIpPortForwardingArgs.builder()
    .dcInterfaceId("string")
    .protocol("string")
    .toDestination("string")
    .description("string")
    .destination("string")
    .name("string")
    .port(0)
    .region("string")
    .source("string")
    .toPort(0)
    .build());
Copy
dc_ip_port_forwarding_resource = vkcs.DcIpPortForwarding("dcIpPortForwardingResource",
    dc_interface_id="string",
    protocol="string",
    to_destination="string",
    description="string",
    destination="string",
    name="string",
    port=0,
    region="string",
    source="string",
    to_port=0)
Copy
const dcIpPortForwardingResource = new vkcs.DcIpPortForwarding("dcIpPortForwardingResource", {
    dcInterfaceId: "string",
    protocol: "string",
    toDestination: "string",
    description: "string",
    destination: "string",
    name: "string",
    port: 0,
    region: "string",
    source: "string",
    toPort: 0,
});
Copy
type: vkcs:DcIpPortForwarding
properties:
    dcInterfaceId: string
    description: string
    destination: string
    name: string
    port: 0
    protocol: string
    region: string
    source: string
    toDestination: string
    toPort: 0
Copy

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

DcInterfaceId This property is required. string
required string → Direct Connect Interface ID. Changing this creates a new resource
Protocol This property is required. string
required string → Protocol. Must be one of: "tcp", "udp", "any".
ToDestination This property is required. string
required string → IP Address of forwarding's destination.
Description string
optional string → Description of the conntrack helper
Destination string
optional string → Destination address selector.
Name string
optional string → Name of the conntrack helper
Port double
optional number → Port selector.
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
Source string
optional string → Source address selector.
ToPort double
optional number → Destination port selector.
DcInterfaceId This property is required. string
required string → Direct Connect Interface ID. Changing this creates a new resource
Protocol This property is required. string
required string → Protocol. Must be one of: "tcp", "udp", "any".
ToDestination This property is required. string
required string → IP Address of forwarding's destination.
Description string
optional string → Description of the conntrack helper
Destination string
optional string → Destination address selector.
Name string
optional string → Name of the conntrack helper
Port float64
optional number → Port selector.
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
Source string
optional string → Source address selector.
ToPort float64
optional number → Destination port selector.
dcInterfaceId This property is required. String
required string → Direct Connect Interface ID. Changing this creates a new resource
protocol This property is required. String
required string → Protocol. Must be one of: "tcp", "udp", "any".
toDestination This property is required. String
required string → IP Address of forwarding's destination.
description String
optional string → Description of the conntrack helper
destination String
optional string → Destination address selector.
name String
optional string → Name of the conntrack helper
port Double
optional number → Port selector.
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
source String
optional string → Source address selector.
toPort Double
optional number → Destination port selector.
dcInterfaceId This property is required. string
required string → Direct Connect Interface ID. Changing this creates a new resource
protocol This property is required. string
required string → Protocol. Must be one of: "tcp", "udp", "any".
toDestination This property is required. string
required string → IP Address of forwarding's destination.
description string
optional string → Description of the conntrack helper
destination string
optional string → Destination address selector.
name string
optional string → Name of the conntrack helper
port number
optional number → Port selector.
region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
source string
optional string → Source address selector.
toPort number
optional number → Destination port selector.
dc_interface_id This property is required. str
required string → Direct Connect Interface ID. Changing this creates a new resource
protocol This property is required. str
required string → Protocol. Must be one of: "tcp", "udp", "any".
to_destination This property is required. str
required string → IP Address of forwarding's destination.
description str
optional string → Description of the conntrack helper
destination str
optional string → Destination address selector.
name str
optional string → Name of the conntrack helper
port float
optional number → Port selector.
region str
optional string → The region to fetch availability zones from, defaults to the provider's region.
source str
optional string → Source address selector.
to_port float
optional number → Destination port selector.
dcInterfaceId This property is required. String
required string → Direct Connect Interface ID. Changing this creates a new resource
protocol This property is required. String
required string → Protocol. Must be one of: "tcp", "udp", "any".
toDestination This property is required. String
required string → IP Address of forwarding's destination.
description String
optional string → Description of the conntrack helper
destination String
optional string → Destination address selector.
name String
optional string → Name of the conntrack helper
port Number
optional number → Port selector.
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
source String
optional string → Source address selector.
toPort Number
optional number → Destination port selector.

Outputs

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

CreatedAt string
string → Creation timestamp
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
string → Update timestamp
CreatedAt string
string → Creation timestamp
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt string
string → Update timestamp
createdAt String
string → Creation timestamp
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
string → Update timestamp
createdAt string
string → Creation timestamp
id string
The provider-assigned unique ID for this managed resource.
updatedAt string
string → Update timestamp
created_at str
string → Creation timestamp
id str
The provider-assigned unique ID for this managed resource.
updated_at str
string → Update timestamp
createdAt String
string → Creation timestamp
id String
The provider-assigned unique ID for this managed resource.
updatedAt String
string → Update timestamp

Look up Existing DcIpPortForwarding Resource

Get an existing DcIpPortForwarding 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?: DcIpPortForwardingState, opts?: CustomResourceOptions): DcIpPortForwarding
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        dc_interface_id: Optional[str] = None,
        description: Optional[str] = None,
        destination: Optional[str] = None,
        name: Optional[str] = None,
        port: Optional[float] = None,
        protocol: Optional[str] = None,
        region: Optional[str] = None,
        source: Optional[str] = None,
        to_destination: Optional[str] = None,
        to_port: Optional[float] = None,
        updated_at: Optional[str] = None) -> DcIpPortForwarding
func GetDcIpPortForwarding(ctx *Context, name string, id IDInput, state *DcIpPortForwardingState, opts ...ResourceOption) (*DcIpPortForwarding, error)
public static DcIpPortForwarding Get(string name, Input<string> id, DcIpPortForwardingState? state, CustomResourceOptions? opts = null)
public static DcIpPortForwarding get(String name, Output<String> id, DcIpPortForwardingState state, CustomResourceOptions options)
resources:  _:    type: vkcs:DcIpPortForwarding    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:
CreatedAt string
string → Creation timestamp
DcInterfaceId string
required string → Direct Connect Interface ID. Changing this creates a new resource
Description string
optional string → Description of the conntrack helper
Destination string
optional string → Destination address selector.
Name string
optional string → Name of the conntrack helper
Port double
optional number → Port selector.
Protocol string
required string → Protocol. Must be one of: "tcp", "udp", "any".
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
Source string
optional string → Source address selector.
ToDestination string
required string → IP Address of forwarding's destination.
ToPort double
optional number → Destination port selector.
UpdatedAt string
string → Update timestamp
CreatedAt string
string → Creation timestamp
DcInterfaceId string
required string → Direct Connect Interface ID. Changing this creates a new resource
Description string
optional string → Description of the conntrack helper
Destination string
optional string → Destination address selector.
Name string
optional string → Name of the conntrack helper
Port float64
optional number → Port selector.
Protocol string
required string → Protocol. Must be one of: "tcp", "udp", "any".
Region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
Source string
optional string → Source address selector.
ToDestination string
required string → IP Address of forwarding's destination.
ToPort float64
optional number → Destination port selector.
UpdatedAt string
string → Update timestamp
createdAt String
string → Creation timestamp
dcInterfaceId String
required string → Direct Connect Interface ID. Changing this creates a new resource
description String
optional string → Description of the conntrack helper
destination String
optional string → Destination address selector.
name String
optional string → Name of the conntrack helper
port Double
optional number → Port selector.
protocol String
required string → Protocol. Must be one of: "tcp", "udp", "any".
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
source String
optional string → Source address selector.
toDestination String
required string → IP Address of forwarding's destination.
toPort Double
optional number → Destination port selector.
updatedAt String
string → Update timestamp
createdAt string
string → Creation timestamp
dcInterfaceId string
required string → Direct Connect Interface ID. Changing this creates a new resource
description string
optional string → Description of the conntrack helper
destination string
optional string → Destination address selector.
name string
optional string → Name of the conntrack helper
port number
optional number → Port selector.
protocol string
required string → Protocol. Must be one of: "tcp", "udp", "any".
region string
optional string → The region to fetch availability zones from, defaults to the provider's region.
source string
optional string → Source address selector.
toDestination string
required string → IP Address of forwarding's destination.
toPort number
optional number → Destination port selector.
updatedAt string
string → Update timestamp
created_at str
string → Creation timestamp
dc_interface_id str
required string → Direct Connect Interface ID. Changing this creates a new resource
description str
optional string → Description of the conntrack helper
destination str
optional string → Destination address selector.
name str
optional string → Name of the conntrack helper
port float
optional number → Port selector.
protocol str
required string → Protocol. Must be one of: "tcp", "udp", "any".
region str
optional string → The region to fetch availability zones from, defaults to the provider's region.
source str
optional string → Source address selector.
to_destination str
required string → IP Address of forwarding's destination.
to_port float
optional number → Destination port selector.
updated_at str
string → Update timestamp
createdAt String
string → Creation timestamp
dcInterfaceId String
required string → Direct Connect Interface ID. Changing this creates a new resource
description String
optional string → Description of the conntrack helper
destination String
optional string → Destination address selector.
name String
optional string → Name of the conntrack helper
port Number
optional number → Port selector.
protocol String
required string → Protocol. Must be one of: "tcp", "udp", "any".
region String
optional string → The region to fetch availability zones from, defaults to the provider's region.
source String
optional string → Source address selector.
toDestination String
required string → IP Address of forwarding's destination.
toPort Number
optional number → Destination port selector.
updatedAt String
string → Update timestamp

Import

Direct connect IP port forwarding can be imported using the id, e.g.

$ pulumi import vkcs:index/dcIpPortForwarding:DcIpPortForwarding mydcipportforwarding 659be09e-a10e-4762-b729-7a003af40f29
Copy

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

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs