Viewing docs for outscale 1.4.0
published on Tuesday, Feb 24, 2026 by outscale
published on Tuesday, Feb 24, 2026 by outscale
Viewing docs for outscale 1.4.0
published on Tuesday, Feb 24, 2026 by outscale
published on Tuesday, Feb 24, 2026 by outscale
Provides information about a client 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 clientGateway01 = outscale.getClientGateway({
filters: [{
name: "client_gateway_ids",
values: ["cgw-12345678"],
}],
});
import pulumi
import pulumi_outscale as outscale
client_gateway01 = outscale.get_client_gateway(filters=[{
"name": "client_gateway_ids",
"values": ["cgw-12345678"],
}])
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.LookupClientGateway(ctx, &outscale.LookupClientGatewayArgs{
Filters: []outscale.GetClientGatewayFilter{
{
Name: "client_gateway_ids",
Values: []string{
"cgw-12345678",
},
},
},
}, 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 clientGateway01 = Outscale.GetClientGateway.Invoke(new()
{
Filters = new[]
{
new Outscale.Inputs.GetClientGatewayFilterInputArgs
{
Name = "client_gateway_ids",
Values = new[]
{
"cgw-12345678",
},
},
},
});
});
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.GetClientGatewayArgs;
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 clientGateway01 = OutscaleFunctions.getClientGateway(GetClientGatewayArgs.builder()
.filters(GetClientGatewayFilterArgs.builder()
.name("client_gateway_ids")
.values("cgw-12345678")
.build())
.build());
}
}
variables:
clientGateway01:
fn::invoke:
function: outscale:getClientGateway
arguments:
filters:
- name: client_gateway_ids
values:
- cgw-12345678
Using getClientGateway
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 getClientGateway(args: GetClientGatewayArgs, opts?: InvokeOptions): Promise<GetClientGatewayResult>
function getClientGatewayOutput(args: GetClientGatewayOutputArgs, opts?: InvokeOptions): Output<GetClientGatewayResult>def get_client_gateway(client_gateway_id: Optional[str] = None,
filters: Optional[Sequence[GetClientGatewayFilter]] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetClientGatewayResult
def get_client_gateway_output(client_gateway_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetClientGatewayFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetClientGatewayResult]func LookupClientGateway(ctx *Context, args *LookupClientGatewayArgs, opts ...InvokeOption) (*LookupClientGatewayResult, error)
func LookupClientGatewayOutput(ctx *Context, args *LookupClientGatewayOutputArgs, opts ...InvokeOption) LookupClientGatewayResultOutput> Note: This function is named LookupClientGateway in the Go SDK.
public static class GetClientGateway
{
public static Task<GetClientGatewayResult> InvokeAsync(GetClientGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetClientGatewayResult> Invoke(GetClientGatewayInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetClientGatewayResult> getClientGateway(GetClientGatewayArgs args, InvokeOptions options)
public static Output<GetClientGatewayResult> getClientGateway(GetClientGatewayArgs args, InvokeOptions options)
fn::invoke:
function: outscale:index/getClientGateway:getClientGateway
arguments:
# arguments dictionaryThe following arguments are supported:
- Client
Gateway stringId - The ID of the client gateway.
- Filters
List<Get
Client Gateway Filter> - 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 stringId - The ID of the client gateway.
- Filters
[]Get
Client Gateway Filter - 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 StringId - The ID of the client gateway.
- filters
List<Get
Client Gateway Filter> - 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 stringId - The ID of the client gateway.
- filters
Get
Client Gateway Filter[] - 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_ strid - The ID of the client gateway.
- filters
Sequence[Get
Client Gateway Filter] - 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
- client
Gateway StringId - The ID of the client gateway.
- 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
getClientGateway Result
The following output properties are available:
- Bgp
Asn double - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- Connection
Type string - The type of communication tunnel used by the client gateway (always
ipsec.1). - Id string
- Public
Ip string - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- Request
Id string - State string
- The state of the client gateway (
pending|available|deleting|deleted). -
List<Get
Client Gateway Tag> - One or more tags associated with the client gateway.
- Client
Gateway stringId - The ID of the client gateway.
- Filters
List<Get
Client Gateway Filter>
- Bgp
Asn float64 - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- Connection
Type string - The type of communication tunnel used by the client gateway (always
ipsec.1). - Id string
- Public
Ip string - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- Request
Id string - State string
- The state of the client gateway (
pending|available|deleting|deleted). -
[]Get
Client Gateway Tag - One or more tags associated with the client gateway.
- Client
Gateway stringId - The ID of the client gateway.
- Filters
[]Get
Client Gateway Filter
- bgp
Asn Double - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- connection
Type String - The type of communication tunnel used by the client gateway (always
ipsec.1). - id String
- public
Ip String - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- request
Id String - state String
- The state of the client gateway (
pending|available|deleting|deleted). -
List<Get
Client Gateway Tag> - One or more tags associated with the client gateway.
- client
Gateway StringId - The ID of the client gateway.
- filters
List<Get
Client Gateway Filter>
- bgp
Asn number - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- connection
Type string - The type of communication tunnel used by the client gateway (always
ipsec.1). - id string
- public
Ip string - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- request
Id string - state string
- The state of the client gateway (
pending|available|deleting|deleted). -
Get
Client Gateway Tag[] - One or more tags associated with the client gateway.
- client
Gateway stringId - The ID of the client gateway.
- filters
Get
Client Gateway Filter[]
- 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.
- connection_
type str - The type of communication tunnel used by the client gateway (always
ipsec.1). - id str
- public_
ip str - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- request_
id str - state str
- The state of the client gateway (
pending|available|deleting|deleted). -
Sequence[Get
Client Gateway Tag] - One or more tags associated with the client gateway.
- client_
gateway_ strid - The ID of the client gateway.
- filters
Sequence[Get
Client Gateway Filter]
- bgp
Asn Number - The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
- connection
Type String - The type of communication tunnel used by the client gateway (always
ipsec.1). - id String
- public
Ip String - The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
- request
Id String - state String
- The state of the client gateway (
pending|available|deleting|deleted). - List<Property Map>
- One or more tags associated with the client gateway.
- client
Gateway StringId - The ID of the client gateway.
- filters List<Property Map>
Supporting Types
GetClientGatewayFilter
GetClientGatewayTag
Package Details
- Repository
- outscale outscale/terraform-provider-outscale
- License
- Notes
- This Pulumi package is based on the
outscaleTerraform Provider.
Viewing docs for outscale 1.4.0
published on Tuesday, Feb 24, 2026 by outscale
published on Tuesday, Feb 24, 2026 by outscale
