Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Outscale Provider
  3. API Docs
  4. VirtualGateway
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

outscale.VirtualGateway

Explore with Pulumi AI

outscale logo
outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
outscale/terraform-provider-outscale

    Manages a virtual gateway.

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

    Example Usage

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

const virtualGateway01 = new outscale.VirtualGateway("virtualGateway01", {
    connectionType: "ipsec.1",
    tags: [{
        key: "name",
        value: "terraform-virtual-gateway",
    }],
});

    import pulumi
import pulumi_outscale as outscale

virtual_gateway01 = outscale.VirtualGateway("virtualGateway01",
    connection_type="ipsec.1",
    tags=[{
        "key": "name",
        "value": "terraform-virtual-gateway",
    }])

    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"),
			Tags: outscale.VirtualGatewayTagArray{
				&outscale.VirtualGatewayTagArgs{
					Key:   pulumi.String("name"),
					Value: pulumi.String("terraform-virtual-gateway"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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",
        Tags = new[]
        {
            new Outscale.Inputs.VirtualGatewayTagArgs
            {
                Key = "name",
                Value = "terraform-virtual-gateway",
            },
        },
    });

});

    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.inputs.VirtualGatewayTagArgs;
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")
            .tags(VirtualGatewayTagArgs.builder()
                .key("name")
                .value("terraform-virtual-gateway")
                .build())
            .build());

    }
}

    resources:
  virtualGateway01:
    type: outscale:VirtualGateway
    properties:
      connectionType: ipsec.1
      tags:
        - key: name
          value: terraform-virtual-gateway

    Create VirtualGateway Resource

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

    Constructor syntax

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

@overload
def VirtualGateway(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   connection_type: Optional[str] = None,
                   net_to_virtual_gateway_links: Optional[Sequence[VirtualGatewayNetToVirtualGatewayLinkArgs]] = None,
                   outscale_virtual_gateway_id: Optional[str] = None,
                   request_id: Optional[str] = None,
                   state: Optional[str] = None,
                   tags: Optional[Sequence[VirtualGatewayTagArgs]] = None,
                   virtual_gateway_id: Optional[str] = None)
    func NewVirtualGateway(ctx *Context, name string, args VirtualGatewayArgs, opts ...ResourceOption) (*VirtualGateway, error)
    public VirtualGateway(string name, VirtualGatewayArgs args, CustomResourceOptions? opts = null)
    public VirtualGateway(String name, VirtualGatewayArgs args)
public VirtualGateway(String name, VirtualGatewayArgs args, CustomResourceOptions options)

    type: outscale:VirtualGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualGatewayArgs
    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 virtualGatewayResource = new Outscale.VirtualGateway("virtualGatewayResource", new()
{
    ConnectionType = "string",
    NetToVirtualGatewayLinks = new[]
    {
        new Outscale.Inputs.VirtualGatewayNetToVirtualGatewayLinkArgs
        {
            NetId = "string",
            State = "string",
        },
    },
    OutscaleVirtualGatewayId = "string",
    RequestId = "string",
    State = "string",
    Tags = new[]
    {
        new Outscale.Inputs.VirtualGatewayTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
    VirtualGatewayId = "string",
});

    example, err := outscale.NewVirtualGateway(ctx, "virtualGatewayResource", &outscale.VirtualGatewayArgs{
ConnectionType: pulumi.String("string"),
NetToVirtualGatewayLinks: .VirtualGatewayNetToVirtualGatewayLinkArray{
&.VirtualGatewayNetToVirtualGatewayLinkArgs{
NetId: pulumi.String("string"),
State: pulumi.String("string"),
},
},
OutscaleVirtualGatewayId: pulumi.String("string"),
RequestId: pulumi.String("string"),
State: pulumi.String("string"),
Tags: .VirtualGatewayTagArray{
&.VirtualGatewayTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
VirtualGatewayId: pulumi.String("string"),
})

    var virtualGatewayResource = new VirtualGateway("virtualGatewayResource", VirtualGatewayArgs.builder()
    .connectionType("string")
    .netToVirtualGatewayLinks(VirtualGatewayNetToVirtualGatewayLinkArgs.builder()
        .netId("string")
        .state("string")
        .build())
    .outscaleVirtualGatewayId("string")
    .requestId("string")
    .state("string")
    .tags(VirtualGatewayTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .virtualGatewayId("string")
    .build());

    virtual_gateway_resource = outscale.VirtualGateway("virtualGatewayResource",
    connection_type="string",
    net_to_virtual_gateway_links=[{
        "net_id": "string",
        "state": "string",
    }],
    outscale_virtual_gateway_id="string",
    request_id="string",
    state="string",
    tags=[{
        "key": "string",
        "value": "string",
    }],
    virtual_gateway_id="string")

    const virtualGatewayResource = new outscale.VirtualGateway("virtualGatewayResource", {
    connectionType: "string",
    netToVirtualGatewayLinks: [{
        netId: "string",
        state: "string",
    }],
    outscaleVirtualGatewayId: "string",
    requestId: "string",
    state: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
    virtualGatewayId: "string",
});

    type: outscale:VirtualGateway
properties:
    connectionType: string
    netToVirtualGatewayLinks:
        - netId: string
          state: string
    outscaleVirtualGatewayId: string
    requestId: string
    state: string
    tags:
        - key: string
          value: string
    virtualGatewayId: string

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

    ConnectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    NetToVirtualGatewayLinks List<VirtualGatewayNetToVirtualGatewayLink>
    The Net to which the virtual gateway is attached.
    OutscaleVirtualGatewayId string
    RequestId string
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    Tags List<VirtualGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    VirtualGatewayId string
    The ID of the virtual gateway.
    ConnectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    NetToVirtualGatewayLinks []VirtualGatewayNetToVirtualGatewayLinkArgs
    The Net to which the virtual gateway is attached.
    OutscaleVirtualGatewayId string
    RequestId string
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    Tags []VirtualGatewayTagArgs
    A tag to add to this resource. You can specify this argument several times.
    VirtualGatewayId string
    The ID of the virtual gateway.
    connectionType String
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks List<VirtualGatewayNetToVirtualGatewayLink>
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId String
    requestId String
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags List<VirtualGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId String
    The ID of the virtual gateway.
    connectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks VirtualGatewayNetToVirtualGatewayLink[]
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId string
    requestId string
    state string
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags VirtualGatewayTag[]
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId string
    The ID of the virtual gateway.
    connection_type str
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    net_to_virtual_gateway_links Sequence[VirtualGatewayNetToVirtualGatewayLinkArgs]
    The Net to which the virtual gateway is attached.
    outscale_virtual_gateway_id str
    request_id str
    state str
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags Sequence[VirtualGatewayTagArgs]
    A tag to add to this resource. You can specify this argument several times.
    virtual_gateway_id str
    The ID of the virtual gateway.
    connectionType String
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks List<Property Map>
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId String
    requestId String
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags List<Property Map>
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId String
    The ID of the virtual gateway.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VirtualGateway Resource

    Get an existing VirtualGateway 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?: VirtualGatewayState, opts?: CustomResourceOptions): VirtualGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connection_type: Optional[str] = None,
        net_to_virtual_gateway_links: Optional[Sequence[VirtualGatewayNetToVirtualGatewayLinkArgs]] = None,
        outscale_virtual_gateway_id: Optional[str] = None,
        request_id: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[VirtualGatewayTagArgs]] = None,
        virtual_gateway_id: Optional[str] = None) -> VirtualGateway
    func GetVirtualGateway(ctx *Context, name string, id IDInput, state *VirtualGatewayState, opts ...ResourceOption) (*VirtualGateway, error)
    public static VirtualGateway Get(string name, Input<string> id, VirtualGatewayState? state, CustomResourceOptions? opts = null)
    public static VirtualGateway get(String name, Output<String> id, VirtualGatewayState state, CustomResourceOptions options)
    resources:  _:    type: outscale:VirtualGateway    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ConnectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    NetToVirtualGatewayLinks List<VirtualGatewayNetToVirtualGatewayLink>
    The Net to which the virtual gateway is attached.
    OutscaleVirtualGatewayId string
    RequestId string
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    Tags List<VirtualGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    VirtualGatewayId string
    The ID of the virtual gateway.
    ConnectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    NetToVirtualGatewayLinks []VirtualGatewayNetToVirtualGatewayLinkArgs
    The Net to which the virtual gateway is attached.
    OutscaleVirtualGatewayId string
    RequestId string
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    Tags []VirtualGatewayTagArgs
    A tag to add to this resource. You can specify this argument several times.
    VirtualGatewayId string
    The ID of the virtual gateway.
    connectionType String
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks List<VirtualGatewayNetToVirtualGatewayLink>
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId String
    requestId String
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags List<VirtualGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId String
    The ID of the virtual gateway.
    connectionType string
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks VirtualGatewayNetToVirtualGatewayLink[]
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId string
    requestId string
    state string
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags VirtualGatewayTag[]
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId string
    The ID of the virtual gateway.
    connection_type str
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    net_to_virtual_gateway_links Sequence[VirtualGatewayNetToVirtualGatewayLinkArgs]
    The Net to which the virtual gateway is attached.
    outscale_virtual_gateway_id str
    request_id str
    state str
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags Sequence[VirtualGatewayTagArgs]
    A tag to add to this resource. You can specify this argument several times.
    virtual_gateway_id str
    The ID of the virtual gateway.
    connectionType String
    The type of VPN connection supported by the virtual gateway (always ipsec.1).
    netToVirtualGatewayLinks List<Property Map>
    The Net to which the virtual gateway is attached.
    outscaleVirtualGatewayId String
    requestId String
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).
    tags List<Property Map>
    A tag to add to this resource. You can specify this argument several times.
    virtualGatewayId String
    The ID of the virtual gateway.

    Supporting Types

    NetId string
    The ID of the Net to which the virtual gateway is attached.
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    NetId string
    The ID of the Net to which the virtual gateway is attached.
    State string
    The state of the virtual gateway (pending | available | deleting | deleted).
    netId String
    The ID of the Net to which the virtual gateway is attached.
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).
    netId string
    The ID of the Net to which the virtual gateway is attached.
    state string
    The state of the virtual gateway (pending | available | deleting | deleted).
    net_id str
    The ID of the Net to which the virtual gateway is attached.
    state str
    The state of the virtual gateway (pending | available | deleting | deleted).
    netId String
    The ID of the Net to which the virtual gateway is attached.
    state String
    The state of the virtual gateway (pending | available | deleting | deleted).

    VirtualGatewayTag, VirtualGatewayTagArgs

    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    Key string
    The key of the tag, with a minimum of 1 character.
    Value string
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.
    key string
    The key of the tag, with a minimum of 1 character.
    value string
    The value of the tag, between 0 and 255 characters.
    key str
    The key of the tag, with a minimum of 1 character.
    value str
    The value of the tag, between 0 and 255 characters.
    key String
    The key of the tag, with a minimum of 1 character.
    value String
    The value of the tag, between 0 and 255 characters.

    Import

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

    console

    $ pulumi import outscale:index/virtualGateway:VirtualGateway ImportedVirtualGateway vgw-12345678

    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.
    outscale logo
    outscale 1.0.1 published on Thursday, Mar 13, 2025 by outscale
    outscale/terraform-provider-outscale