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

outscale.getClientGateways

Explore with Pulumi AI

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

    Provides information about client gateways.

    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 clientGateways01 = outscale.getClientGateways({
    filters: [
        {
            name: "bgp_asns",
            values: ["65000"],
        },
        {
            name: "public_ips",
            values: [
                "111.11.111.1",
                "222.22.222.2",
            ],
        },
    ],
});

    import pulumi
import pulumi_outscale as outscale

client_gateways01 = outscale.get_client_gateways(filters=[
    {
        "name": "bgp_asns",
        "values": ["65000"],
    },
    {
        "name": "public_ips",
        "values": [
            "111.11.111.1",
            "222.22.222.2",
        ],
    },
])

    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.GetClientGateways(ctx, &outscale.GetClientGatewaysArgs{
			Filters: []outscale.GetClientGatewaysFilter{
				{
					Name: "bgp_asns",
					Values: []string{
						"65000",
					},
				},
				{
					Name: "public_ips",
					Values: []string{
						"111.11.111.1",
						"222.22.222.2",
					},
				},
			},
		}, nil)
		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 clientGateways01 = Outscale.GetClientGateways.Invoke(new()
    {
        Filters = new[]
        {
            new Outscale.Inputs.GetClientGatewaysFilterInputArgs
            {
                Name = "bgp_asns",
                Values = new[]
                {
                    "65000",
                },
            },
            new Outscale.Inputs.GetClientGatewaysFilterInputArgs
            {
                Name = "public_ips",
                Values = new[]
                {
                    "111.11.111.1",
                    "222.22.222.2",
                },
            },
        },
    });

});

    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.GetClientGatewaysArgs;
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 clientGateways01 = OutscaleFunctions.getClientGateways(GetClientGatewaysArgs.builder()
            .filters(            
                GetClientGatewaysFilterArgs.builder()
                    .name("bgp_asns")
                    .values("65000")
                    .build(),
                GetClientGatewaysFilterArgs.builder()
                    .name("public_ips")
                    .values(                    
                        "111.11.111.1",
                        "222.22.222.2")
                    .build())
            .build());

    }
}

    variables:
  clientGateways01:
    fn::invoke:
      function: outscale:getClientGateways
      arguments:
        filters:
          - name: bgp_asns
            values:
              - '65000'
          - name: public_ips
            values:
              - 111.11.111.1
              - 222.22.222.2

    Using getClientGateways

    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 getClientGateways(args: GetClientGatewaysArgs, opts?: InvokeOptions): Promise<GetClientGatewaysResult>
function getClientGatewaysOutput(args: GetClientGatewaysOutputArgs, opts?: InvokeOptions): Output<GetClientGatewaysResult>
    def get_client_gateways(client_gateway_ids: Optional[Sequence[str]] = None,
                        filters: Optional[Sequence[GetClientGatewaysFilter]] = None,
                        id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetClientGatewaysResult
def get_client_gateways_output(client_gateway_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetClientGatewaysFilterArgs]]]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetClientGatewaysResult]
    func GetClientGateways(ctx *Context, args *GetClientGatewaysArgs, opts ...InvokeOption) (*GetClientGatewaysResult, error)
func GetClientGatewaysOutput(ctx *Context, args *GetClientGatewaysOutputArgs, opts ...InvokeOption) GetClientGatewaysResultOutput

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

    public static class GetClientGateways 
{
    public static Task<GetClientGatewaysResult> InvokeAsync(GetClientGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetClientGatewaysResult> Invoke(GetClientGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClientGatewaysResult> getClientGateways(GetClientGatewaysArgs args, InvokeOptions options)
public static Output<GetClientGatewaysResult> getClientGateways(GetClientGatewaysArgs args, InvokeOptions options)

    fn::invoke:
  function: outscale:index/getClientGateways:getClientGateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ClientGatewayIds List<string>
    Filters List<GetClientGatewaysFilter>
    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
    ClientGatewayIds []string
    Filters []GetClientGatewaysFilter
    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
    clientGatewayIds List<String>
    filters List<GetClientGatewaysFilter>
    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
    clientGatewayIds string[]
    filters GetClientGatewaysFilter[]
    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
    client_gateway_ids Sequence[str]
    filters Sequence[GetClientGatewaysFilter]
    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
    clientGatewayIds List<String>
    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

    getClientGateways Result

    The following output properties are available:

    ClientGateways []GetClientGatewaysClientGateway
    Information about one or more client gateways.
    Id string
    RequestId string
    ClientGatewayIds []string
    Filters []GetClientGatewaysFilter
    clientGateways GetClientGatewaysClientGateway[]
    Information about one or more client gateways.
    id string
    requestId string
    clientGatewayIds string[]
    filters GetClientGatewaysFilter[]
    clientGateways List<Property Map>
    Information about one or more client gateways.
    id String
    requestId String
    clientGatewayIds List<String>
    filters List<Property Map>

    Supporting Types

    GetClientGatewaysClientGateway

    BgpAsn double
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    ClientGatewayId string
    The ID of the client gateway.
    ConnectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    PublicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags List<GetClientGatewaysClientGatewayTag>
    One or more tags associated with the client gateway.
    BgpAsn float64
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    ClientGatewayId string
    The ID of the client gateway.
    ConnectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    PublicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags []GetClientGatewaysClientGatewayTag
    One or more tags associated with the client gateway.
    bgpAsn Double
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    clientGatewayId String
    The ID of the client gateway.
    connectionType String
    The type of communication tunnel used by the client gateway (always ipsec.1).
    publicIp String
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    tags List<GetClientGatewaysClientGatewayTag>
    One or more tags associated with the client gateway.
    bgpAsn number
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    clientGatewayId string
    The ID of the client gateway.
    connectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    publicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    state string
    The state of the client gateway (pending | available | deleting | deleted).
    tags GetClientGatewaysClientGatewayTag[]
    One or more tags associated with the client gateway.
    bgp_asn float
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    client_gateway_id str
    The ID of the client gateway.
    connection_type str
    The type of communication tunnel used by the client gateway (always ipsec.1).
    public_ip str
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    state str
    The state of the client gateway (pending | available | deleting | deleted).
    tags Sequence[GetClientGatewaysClientGatewayTag]
    One or more tags associated with the client gateway.
    bgpAsn Number
    The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
    clientGatewayId String
    The ID of the client gateway.
    connectionType String
    The type of communication tunnel used by the client gateway (always ipsec.1).
    publicIp String
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    tags List<Property Map>
    One or more tags associated with the client gateway.

    GetClientGatewaysClientGatewayTag

    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.

    GetClientGatewaysFilter

    Name string
    Values List<string>
    Name string
    Values []string
    name String
    values List<String>
    name string
    values string[]
    name str
    values Sequence[str]
    name String
    values List<String>

    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