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

outscale.getVirtualGateway

Explore with Pulumi AI

outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale

Provides information about 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 = outscale.getVirtualGateway({
    filters: [{
        name: "virtual_gateway_ids",
        values: ["vgw-12345678"],
    }],
});
Copy
import pulumi
import pulumi_outscale as outscale

virtual_gateway01 = outscale.get_virtual_gateway(filters=[{
    "name": "virtual_gateway_ids",
    "values": ["vgw-12345678"],
}])
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.LookupVirtualGateway(ctx, &outscale.LookupVirtualGatewayArgs{
			Filters: []outscale.GetVirtualGatewayFilter{
				{
					Name: "virtual_gateway_ids",
					Values: []string{
						"vgw-12345678",
					},
				},
			},
		}, nil)
		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 = Outscale.GetVirtualGateway.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetVirtualGatewayFilterInputArgs
            {
                Name = "virtual_gateway_ids",
                Values = new[]
                {
                    "vgw-12345678",
                },
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.OutscaleFunctions;
import com.pulumi.outscale.inputs.GetVirtualGatewayArgs;
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 virtualGateway01 = OutscaleFunctions.getVirtualGateway(GetVirtualGatewayArgs.builder()
            .filters(GetVirtualGatewayFilterArgs.builder()
                .name("virtual_gateway_ids")
                .values("vgw-12345678")
                .build())
            .build());

    }
}
Copy
variables:
  virtualGateway01:
    fn::invoke:
      function: outscale:getVirtualGateway
      arguments:
        filters:
          - name: virtual_gateway_ids
            values:
              - vgw-12345678
Copy

Using getVirtualGateway

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVirtualGateway(args: GetVirtualGatewayArgs, opts?: InvokeOptions): Promise<GetVirtualGatewayResult>
function getVirtualGatewayOutput(args: GetVirtualGatewayOutputArgs, opts?: InvokeOptions): Output<GetVirtualGatewayResult>
Copy
def get_virtual_gateway(connection_type: Optional[str] = None,
                        filters: Optional[Sequence[GetVirtualGatewayFilter]] = None,
                        id: Optional[str] = None,
                        state: Optional[str] = None,
                        virtual_gateway_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualGatewayResult
def get_virtual_gateway_output(connection_type: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetVirtualGatewayFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        state: Optional[pulumi.Input[str]] = None,
                        virtual_gateway_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualGatewayResult]
Copy
func LookupVirtualGateway(ctx *Context, args *LookupVirtualGatewayArgs, opts ...InvokeOption) (*LookupVirtualGatewayResult, error)
func LookupVirtualGatewayOutput(ctx *Context, args *LookupVirtualGatewayOutputArgs, opts ...InvokeOption) LookupVirtualGatewayResultOutput
Copy

> Note: This function is named LookupVirtualGateway in the Go SDK.

public static class GetVirtualGateway 
{
    public static Task<GetVirtualGatewayResult> InvokeAsync(GetVirtualGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualGatewayResult> Invoke(GetVirtualGatewayInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVirtualGatewayResult> getVirtualGateway(GetVirtualGatewayArgs args, InvokeOptions options)
public static Output<GetVirtualGatewayResult> getVirtualGateway(GetVirtualGatewayArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getVirtualGateway:getVirtualGateway
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ConnectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
Filters List<GetVirtualGatewayFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
State string
The state of the virtual gateway (pending | available | deleting | deleted).
VirtualGatewayId string
The ID of the virtual gateway.
ConnectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
Filters []GetVirtualGatewayFilter
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
Id string
State string
The state of the virtual gateway (pending | available | deleting | deleted).
VirtualGatewayId string
The ID of the virtual gateway.
connectionType String
The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters List<GetVirtualGatewayFilter>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
state String
The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId String
The ID of the virtual gateway.
connectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters GetVirtualGatewayFilter[]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id string
state string
The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId string
The ID of the virtual gateway.
connection_type str
The type of VPN connection supported by the virtual gateway (always ipsec.1).
filters Sequence[GetVirtualGatewayFilter]
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id str
state str
The state of the virtual gateway (pending | available | deleting | deleted).
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).
filters List<Property Map>
A combination of a filter name and one or more filter values. You can specify this argument for as many filter names as you need. The filter name can be any of the following:
id String
state String
The state of the virtual gateway (pending | available | deleting | deleted).
virtualGatewayId String
The ID of the virtual gateway.

getVirtualGateway Result

The following output properties are available:

ConnectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
Id string
NetToVirtualGatewayLinks List<GetVirtualGatewayNetToVirtualGatewayLink>
The Net to which the virtual gateway is attached.
RequestId string
State string
The state of the virtual gateway (pending | available | deleting | deleted).
Tags List<GetVirtualGatewayTag>
One or more tags associated with the virtual gateway.
VirtualGatewayId string
The ID of the virtual gateway.
Filters List<GetVirtualGatewayFilter>
ConnectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
Id string
NetToVirtualGatewayLinks []GetVirtualGatewayNetToVirtualGatewayLink
The Net to which the virtual gateway is attached.
RequestId string
State string
The state of the virtual gateway (pending | available | deleting | deleted).
Tags []GetVirtualGatewayTag
One or more tags associated with the virtual gateway.
VirtualGatewayId string
The ID of the virtual gateway.
Filters []GetVirtualGatewayFilter
connectionType String
The type of VPN connection supported by the virtual gateway (always ipsec.1).
id String
netToVirtualGatewayLinks List<GetVirtualGatewayNetToVirtualGatewayLink>
The Net to which the virtual gateway is attached.
requestId String
state String
The state of the virtual gateway (pending | available | deleting | deleted).
tags List<GetVirtualGatewayTag>
One or more tags associated with the virtual gateway.
virtualGatewayId String
The ID of the virtual gateway.
filters List<GetVirtualGatewayFilter>
connectionType string
The type of VPN connection supported by the virtual gateway (always ipsec.1).
id string
netToVirtualGatewayLinks GetVirtualGatewayNetToVirtualGatewayLink[]
The Net to which the virtual gateway is attached.
requestId string
state string
The state of the virtual gateway (pending | available | deleting | deleted).
tags GetVirtualGatewayTag[]
One or more tags associated with the virtual gateway.
virtualGatewayId string
The ID of the virtual gateway.
filters GetVirtualGatewayFilter[]
connection_type str
The type of VPN connection supported by the virtual gateway (always ipsec.1).
id str
net_to_virtual_gateway_links Sequence[GetVirtualGatewayNetToVirtualGatewayLink]
The Net to which the virtual gateway is attached.
request_id str
state str
The state of the virtual gateway (pending | available | deleting | deleted).
tags Sequence[GetVirtualGatewayTag]
One or more tags associated with the virtual gateway.
virtual_gateway_id str
The ID of the virtual gateway.
filters Sequence[GetVirtualGatewayFilter]
connectionType String
The type of VPN connection supported by the virtual gateway (always ipsec.1).
id String
netToVirtualGatewayLinks List<Property Map>
The Net to which the virtual gateway is attached.
requestId String
state String
The state of the virtual gateway (pending | available | deleting | deleted).
tags List<Property Map>
One or more tags associated with the virtual gateway.
virtualGatewayId String
The ID of the virtual gateway.
filters List<Property Map>

Supporting Types

GetVirtualGatewayFilter

Name This property is required. string
Values This property is required. List<string>
Name This property is required. string
Values This property is required. []string
name This property is required. String
values This property is required. List<String>
name This property is required. string
values This property is required. string[]
name This property is required. str
values This property is required. Sequence[str]
name This property is required. String
values This property is required. List<String>
NetId This property is required. string
The ID of the Net to which the virtual gateway is attached.
State This property is required. string
The state of the virtual gateway (pending | available | deleting | deleted).
NetId This property is required. string
The ID of the Net to which the virtual gateway is attached.
State This property is required. string
The state of the virtual gateway (pending | available | deleting | deleted).
netId This property is required. String
The ID of the Net to which the virtual gateway is attached.
state This property is required. String
The state of the virtual gateway (pending | available | deleting | deleted).
netId This property is required. string
The ID of the Net to which the virtual gateway is attached.
state This property is required. string
The state of the virtual gateway (pending | available | deleting | deleted).
net_id This property is required. str
The ID of the Net to which the virtual gateway is attached.
state This property is required. str
The state of the virtual gateway (pending | available | deleting | deleted).
netId This property is required. String
The ID of the Net to which the virtual gateway is attached.
state This property is required. String
The state of the virtual gateway (pending | available | deleting | deleted).

GetVirtualGatewayTag

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

Package Details

Repository
outscale outscale/terraform-provider-outscale
License
Notes
This Pulumi package is based on the outscale Terraform Provider.
outscale 1.1.0 published on Thursday, Apr 3, 2025 by outscale
outscale/terraform-provider-outscale