1. Packages
  2. Outscale Provider
  3. API Docs
  4. VirtualGatewayLink
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale

outscale.VirtualGatewayLink

Explore with Pulumi AI

Manages a virtual gateway link.

For more information on this resource, see the User Guide.
For more information on this resource actions, see the API documentation.

Example Usage

Required resources

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

const virtualGateway01 = new outscale.VirtualGateway("virtualGateway01", {connectionType: "ipsec.1"});
const net01 = new outscale.Net("net01", {ipRange: "10.0.0.0/16"});
Copy
import pulumi
import pulumi_outscale as outscale

virtual_gateway01 = outscale.VirtualGateway("virtualGateway01", connection_type="ipsec.1")
net01 = outscale.Net("net01", ip_range="10.0.0.0/16")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.NewVirtualGateway(ctx, "virtualGateway01", &outscale.VirtualGatewayArgs{
			ConnectionType: pulumi.String("ipsec.1"),
		})
		if err != nil {
			return err
		}
		_, err = outscale.NewNet(ctx, "net01", &outscale.NetArgs{
			IpRange: pulumi.String("10.0.0.0/16"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var virtualGateway01 = new Outscale.VirtualGateway("virtualGateway01", new()
    {
        ConnectionType = "ipsec.1",
    });

    var net01 = new Outscale.Net("net01", new()
    {
        IpRange = "10.0.0.0/16",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.VirtualGateway;
import com.pulumi.outscale.VirtualGatewayArgs;
import com.pulumi.outscale.Net;
import com.pulumi.outscale.NetArgs;
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 virtualGateway01 = new VirtualGateway("virtualGateway01", VirtualGatewayArgs.builder()
            .connectionType("ipsec.1")
            .build());

        var net01 = new Net("net01", NetArgs.builder()
            .ipRange("10.0.0.0/16")
            .build());

    }
}
Copy
resources:
  virtualGateway01:
    type: outscale:VirtualGateway
    properties:
      connectionType: ipsec.1
  net01:
    type: outscale:Net
    properties:
      ipRange: 10.0.0.0/16
Copy
import * as pulumi from "@pulumi/pulumi";
import * as outscale from "@pulumi/outscale";

const virtualGatewayLink01 = new outscale.VirtualGatewayLink("virtualGatewayLink01", {
    virtualGatewayId: outscale_virtual_gateway.virtual_gateway01.virtual_gateway_id,
    netId: outscale_net.net01.net_id,
});
Copy
import pulumi
import pulumi_outscale as outscale

virtual_gateway_link01 = outscale.VirtualGatewayLink("virtualGatewayLink01",
    virtual_gateway_id=outscale_virtual_gateway["virtual_gateway01"]["virtual_gateway_id"],
    net_id=outscale_net["net01"]["net_id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := outscale.NewVirtualGatewayLink(ctx, "virtualGatewayLink01", &outscale.VirtualGatewayLinkArgs{
			VirtualGatewayId: pulumi.Any(outscale_virtual_gateway.Virtual_gateway01.Virtual_gateway_id),
			NetId:            pulumi.Any(outscale_net.Net01.Net_id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Outscale = Pulumi.Outscale;

return await Deployment.RunAsync(() => 
{
    var virtualGatewayLink01 = new Outscale.VirtualGatewayLink("virtualGatewayLink01", new()
    {
        VirtualGatewayId = outscale_virtual_gateway.Virtual_gateway01.Virtual_gateway_id,
        NetId = outscale_net.Net01.Net_id,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.VirtualGatewayLink;
import com.pulumi.outscale.VirtualGatewayLinkArgs;
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 virtualGatewayLink01 = new VirtualGatewayLink("virtualGatewayLink01", VirtualGatewayLinkArgs.builder()
            .virtualGatewayId(outscale_virtual_gateway.virtual_gateway01().virtual_gateway_id())
            .netId(outscale_net.net01().net_id())
            .build());

    }
}
Copy
resources:
  virtualGatewayLink01:
    type: outscale:VirtualGatewayLink
    properties:
      virtualGatewayId: ${outscale_virtual_gateway.virtual_gateway01.virtual_gateway_id}
      netId: ${outscale_net.net01.net_id}
Copy

Create VirtualGatewayLink Resource

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

Constructor syntax

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

@overload
def VirtualGatewayLink(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       net_id: Optional[str] = None,
                       virtual_gateway_id: Optional[str] = None,
                       dry_run: Optional[str] = None,
                       virtual_gateway_link_id: Optional[str] = None)
func NewVirtualGatewayLink(ctx *Context, name string, args VirtualGatewayLinkArgs, opts ...ResourceOption) (*VirtualGatewayLink, error)
public VirtualGatewayLink(string name, VirtualGatewayLinkArgs args, CustomResourceOptions? opts = null)
public VirtualGatewayLink(String name, VirtualGatewayLinkArgs args)
public VirtualGatewayLink(String name, VirtualGatewayLinkArgs args, CustomResourceOptions options)
type: outscale:VirtualGatewayLink
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. VirtualGatewayLinkArgs
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. VirtualGatewayLinkArgs
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. VirtualGatewayLinkArgs
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. VirtualGatewayLinkArgs
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. VirtualGatewayLinkArgs
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 virtualGatewayLinkResource = new Outscale.VirtualGatewayLink("virtualGatewayLinkResource", new()
{
    NetId = "string",
    VirtualGatewayId = "string",
    DryRun = "string",
    VirtualGatewayLinkId = "string",
});
Copy
example, err := outscale.NewVirtualGatewayLink(ctx, "virtualGatewayLinkResource", &outscale.VirtualGatewayLinkArgs{
NetId: pulumi.String("string"),
VirtualGatewayId: pulumi.String("string"),
DryRun: pulumi.String("string"),
VirtualGatewayLinkId: pulumi.String("string"),
})
Copy
var virtualGatewayLinkResource = new VirtualGatewayLink("virtualGatewayLinkResource", VirtualGatewayLinkArgs.builder()
    .netId("string")
    .virtualGatewayId("string")
    .dryRun("string")
    .virtualGatewayLinkId("string")
    .build());
Copy
virtual_gateway_link_resource = outscale.VirtualGatewayLink("virtualGatewayLinkResource",
    net_id="string",
    virtual_gateway_id="string",
    dry_run="string",
    virtual_gateway_link_id="string")
Copy
const virtualGatewayLinkResource = new outscale.VirtualGatewayLink("virtualGatewayLinkResource", {
    netId: "string",
    virtualGatewayId: "string",
    dryRun: "string",
    virtualGatewayLinkId: "string",
});
Copy
type: outscale:VirtualGatewayLink
properties:
    dryRun: string
    netId: string
    virtualGatewayId: string
    virtualGatewayLinkId: string
Copy

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

NetId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
VirtualGatewayId This property is required. string
The ID of the virtual gateway.
DryRun string
VirtualGatewayLinkId string
NetId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
VirtualGatewayId This property is required. string
The ID of the virtual gateway.
DryRun string
VirtualGatewayLinkId string
netId This property is required. String
The ID of the Net to which you want to attach the virtual gateway.
virtualGatewayId This property is required. String
The ID of the virtual gateway.
dryRun String
virtualGatewayLinkId String
netId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
virtualGatewayId This property is required. string
The ID of the virtual gateway.
dryRun string
virtualGatewayLinkId string
net_id This property is required. str
The ID of the Net to which you want to attach the virtual gateway.
virtual_gateway_id This property is required. str
The ID of the virtual gateway.
dry_run str
virtual_gateway_link_id str
netId This property is required. String
The ID of the Net to which you want to attach the virtual gateway.
virtualGatewayId This property is required. String
The ID of the virtual gateway.
dryRun String
virtualGatewayLinkId String

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
NetToVirtualGatewayLinks List<VirtualGatewayLinkNetToVirtualGatewayLink>
RequestId string
Id string
The provider-assigned unique ID for this managed resource.
NetToVirtualGatewayLinks []VirtualGatewayLinkNetToVirtualGatewayLink
RequestId string
id String
The provider-assigned unique ID for this managed resource.
netToVirtualGatewayLinks List<VirtualGatewayLinkNetToVirtualGatewayLink>
requestId String
id string
The provider-assigned unique ID for this managed resource.
netToVirtualGatewayLinks VirtualGatewayLinkNetToVirtualGatewayLink[]
requestId string
id str
The provider-assigned unique ID for this managed resource.
net_to_virtual_gateway_links Sequence[VirtualGatewayLinkNetToVirtualGatewayLink]
request_id str
id String
The provider-assigned unique ID for this managed resource.
netToVirtualGatewayLinks List<Property Map>
requestId String

Look up Existing VirtualGatewayLink Resource

Get an existing VirtualGatewayLink 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?: VirtualGatewayLinkState, opts?: CustomResourceOptions): VirtualGatewayLink
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dry_run: Optional[str] = None,
        net_id: Optional[str] = None,
        net_to_virtual_gateway_links: Optional[Sequence[VirtualGatewayLinkNetToVirtualGatewayLinkArgs]] = None,
        request_id: Optional[str] = None,
        virtual_gateway_id: Optional[str] = None,
        virtual_gateway_link_id: Optional[str] = None) -> VirtualGatewayLink
func GetVirtualGatewayLink(ctx *Context, name string, id IDInput, state *VirtualGatewayLinkState, opts ...ResourceOption) (*VirtualGatewayLink, error)
public static VirtualGatewayLink Get(string name, Input<string> id, VirtualGatewayLinkState? state, CustomResourceOptions? opts = null)
public static VirtualGatewayLink get(String name, Output<String> id, VirtualGatewayLinkState state, CustomResourceOptions options)
resources:  _:    type: outscale:VirtualGatewayLink    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:
DryRun string
NetId string
The ID of the Net to which you want to attach the virtual gateway.
NetToVirtualGatewayLinks List<VirtualGatewayLinkNetToVirtualGatewayLink>
RequestId string
VirtualGatewayId string
The ID of the virtual gateway.
VirtualGatewayLinkId string
DryRun string
NetId string
The ID of the Net to which you want to attach the virtual gateway.
NetToVirtualGatewayLinks []VirtualGatewayLinkNetToVirtualGatewayLinkArgs
RequestId string
VirtualGatewayId string
The ID of the virtual gateway.
VirtualGatewayLinkId string
dryRun String
netId String
The ID of the Net to which you want to attach the virtual gateway.
netToVirtualGatewayLinks List<VirtualGatewayLinkNetToVirtualGatewayLink>
requestId String
virtualGatewayId String
The ID of the virtual gateway.
virtualGatewayLinkId String
dryRun string
netId string
The ID of the Net to which you want to attach the virtual gateway.
netToVirtualGatewayLinks VirtualGatewayLinkNetToVirtualGatewayLink[]
requestId string
virtualGatewayId string
The ID of the virtual gateway.
virtualGatewayLinkId string
dry_run str
net_id str
The ID of the Net to which you want to attach the virtual gateway.
net_to_virtual_gateway_links Sequence[VirtualGatewayLinkNetToVirtualGatewayLinkArgs]
request_id str
virtual_gateway_id str
The ID of the virtual gateway.
virtual_gateway_link_id str
dryRun String
netId String
The ID of the Net to which you want to attach the virtual gateway.
netToVirtualGatewayLinks List<Property Map>
requestId String
virtualGatewayId String
The ID of the virtual gateway.
virtualGatewayLinkId String

Supporting Types

NetId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
State This property is required. string
The state of the attachment (attaching | attached | detaching | detached).
NetId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
State This property is required. string
The state of the attachment (attaching | attached | detaching | detached).
netId This property is required. String
The ID of the Net to which you want to attach the virtual gateway.
state This property is required. String
The state of the attachment (attaching | attached | detaching | detached).
netId This property is required. string
The ID of the Net to which you want to attach the virtual gateway.
state This property is required. string
The state of the attachment (attaching | attached | detaching | detached).
net_id This property is required. str
The ID of the Net to which you want to attach the virtual gateway.
state This property is required. str
The state of the attachment (attaching | attached | detaching | detached).
netId This property is required. String
The ID of the Net to which you want to attach the virtual gateway.
state This property is required. String
The state of the attachment (attaching | attached | detaching | detached).

Import

A virtual gateway link can be imported using its virtual gateway ID. For example:

console

$ pulumi import outscale:index/virtualGatewayLink:VirtualGatewayLink ImportedVirtualGatewayLink vgw-12345678
Copy

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

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.