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

outscale.getClientGateway

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 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 dictionary

    The following arguments are supported:

    ClientGatewayId string
    The ID of the client gateway.
    Filters List<GetClientGatewayFilter>
    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
    ClientGatewayId string
    The ID of the client gateway.
    Filters []GetClientGatewayFilter
    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
    clientGatewayId String
    The ID of the client gateway.
    filters List<GetClientGatewayFilter>
    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
    clientGatewayId string
    The ID of the client gateway.
    filters GetClientGatewayFilter[]
    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_id str
    The ID of the client gateway.
    filters Sequence[GetClientGatewayFilter]
    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
    clientGatewayId String
    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:

    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.
    ConnectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    Id string
    PublicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags List<GetClientGatewayTag>
    One or more tags associated with the client gateway.
    ClientGatewayId string
    The ID of the client gateway.
    Filters List<GetClientGatewayFilter>
    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.
    ConnectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    Id string
    PublicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags []GetClientGatewayTag
    One or more tags associated with the client gateway.
    ClientGatewayId string
    The ID of the client gateway.
    Filters []GetClientGatewayFilter
    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.
    connectionType String
    The type of communication tunnel used by the client gateway (always ipsec.1).
    id String
    publicIp String
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    requestId String
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    tags List<GetClientGatewayTag>
    One or more tags associated with the client gateway.
    clientGatewayId String
    The ID of the client gateway.
    filters List<GetClientGatewayFilter>
    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.
    connectionType string
    The type of communication tunnel used by the client gateway (always ipsec.1).
    id string
    publicIp string
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    requestId string
    state string
    The state of the client gateway (pending | available | deleting | deleted).
    tags GetClientGatewayTag[]
    One or more tags associated with the client gateway.
    clientGatewayId string
    The ID of the client gateway.
    filters GetClientGatewayFilter[]
    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).
    tags Sequence[GetClientGatewayTag]
    One or more tags associated with the client gateway.
    client_gateway_id str
    The ID of the client gateway.
    filters Sequence[GetClientGatewayFilter]
    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.
    connectionType String
    The type of communication tunnel used by the client gateway (always ipsec.1).
    id String
    publicIp String
    The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
    requestId String
    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.
    clientGatewayId String
    The ID of the client gateway.
    filters List<Property Map>

    Supporting Types

    GetClientGatewayFilter

    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>

    GetClientGatewayTag

    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.

    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