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

outscale.getClientGateways

Explore with Pulumi AI

outscale 1.1.0 published on Thursday, Apr 3, 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",
            ],
        },
    ],
});
Copy
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",
        ],
    },
])
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.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
	})
}
Copy
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",
                },
            },
        },
    });

});
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.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());

    }
}
Copy
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
Copy

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>
Copy
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]
Copy
func GetClientGateways(ctx *Context, args *GetClientGatewaysArgs, opts ...InvokeOption) (*GetClientGatewaysResult, error)
func GetClientGatewaysOutput(ctx *Context, args *GetClientGatewaysOutputArgs, opts ...InvokeOption) GetClientGatewaysResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetClientGatewaysResult> getClientGateways(GetClientGatewaysArgs args, InvokeOptions options)
public static Output<GetClientGatewaysResult> getClientGateways(GetClientGatewaysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: outscale:index/getClientGateways:getClientGateways
  arguments:
    # arguments dictionary
Copy

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 This property is required. 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 This property is required. string
The ID of the client gateway.
ConnectionType This property is required. string
The type of communication tunnel used by the client gateway (always ipsec.1).
PublicIp This property is required. string
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
State This property is required. string
The state of the client gateway (pending | available | deleting | deleted).
Tags This property is required. List<GetClientGatewaysClientGatewayTag>
One or more tags associated with the client gateway.
BgpAsn This property is required. 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 This property is required. string
The ID of the client gateway.
ConnectionType This property is required. string
The type of communication tunnel used by the client gateway (always ipsec.1).
PublicIp This property is required. string
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
State This property is required. string
The state of the client gateway (pending | available | deleting | deleted).
Tags This property is required. []GetClientGatewaysClientGatewayTag
One or more tags associated with the client gateway.
bgpAsn This property is required. 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 This property is required. String
The ID of the client gateway.
connectionType This property is required. String
The type of communication tunnel used by the client gateway (always ipsec.1).
publicIp This property is required. String
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
state This property is required. String
The state of the client gateway (pending | available | deleting | deleted).
tags This property is required. List<GetClientGatewaysClientGatewayTag>
One or more tags associated with the client gateway.
bgpAsn This property is required. 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 This property is required. string
The ID of the client gateway.
connectionType This property is required. string
The type of communication tunnel used by the client gateway (always ipsec.1).
publicIp This property is required. string
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
state This property is required. string
The state of the client gateway (pending | available | deleting | deleted).
tags This property is required. GetClientGatewaysClientGatewayTag[]
One or more tags associated with the client gateway.
bgp_asn This property is required. 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 This property is required. str
The ID of the client gateway.
connection_type This property is required. str
The type of communication tunnel used by the client gateway (always ipsec.1).
public_ip This property is required. str
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
state This property is required. str
The state of the client gateway (pending | available | deleting | deleted).
tags This property is required. Sequence[GetClientGatewaysClientGatewayTag]
One or more tags associated with the client gateway.
bgpAsn This property is required. 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 This property is required. String
The ID of the client gateway.
connectionType This property is required. String
The type of communication tunnel used by the client gateway (always ipsec.1).
publicIp This property is required. String
The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
state This property is required. String
The state of the client gateway (pending | available | deleting | deleted).
tags This property is required. List<Property Map>
One or more tags associated with the client gateway.

GetClientGatewaysClientGatewayTag

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.

GetClientGatewaysFilter

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>

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