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

outscale.ClientGateway

Explore with Pulumi AI

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

    Manages 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 = new outscale.ClientGateway("clientGateway01", {
    bgpAsn: 65000,
    connectionType: "ipsec.1",
    publicIp: "111.11.11.111",
    tags: [{
        key: "Name",
        value: "client_gateway_01",
    }],
});

    import pulumi
import pulumi_outscale as outscale

client_gateway01 = outscale.ClientGateway("clientGateway01",
    bgp_asn=65000,
    connection_type="ipsec.1",
    public_ip="111.11.11.111",
    tags=[{
        "key": "Name",
        "value": "client_gateway_01",
    }])

    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.NewClientGateway(ctx, "clientGateway01", &outscale.ClientGatewayArgs{
			BgpAsn:         pulumi.Float64(65000),
			ConnectionType: pulumi.String("ipsec.1"),
			PublicIp:       pulumi.String("111.11.11.111"),
			Tags: outscale.ClientGatewayTagArray{
				&outscale.ClientGatewayTagArgs{
					Key:   pulumi.String("Name"),
					Value: pulumi.String("client_gateway_01"),
				},
			},
		})
		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 = new Outscale.ClientGateway("clientGateway01", new()
    {
        BgpAsn = 65000,
        ConnectionType = "ipsec.1",
        PublicIp = "111.11.11.111",
        Tags = new[]
        {
            new Outscale.Inputs.ClientGatewayTagArgs
            {
                Key = "Name",
                Value = "client_gateway_01",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.outscale.ClientGateway;
import com.pulumi.outscale.ClientGatewayArgs;
import com.pulumi.outscale.inputs.ClientGatewayTagArgs;
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) {
        var clientGateway01 = new ClientGateway("clientGateway01", ClientGatewayArgs.builder()
            .bgpAsn(65000)
            .connectionType("ipsec.1")
            .publicIp("111.11.11.111")
            .tags(ClientGatewayTagArgs.builder()
                .key("Name")
                .value("client_gateway_01")
                .build())
            .build());

    }
}

    resources:
  clientGateway01:
    type: outscale:ClientGateway
    properties:
      bgpAsn: 65000
      connectionType: ipsec.1
      publicIp: 111.11.11.111
      tags:
        - key: Name
          value: client_gateway_01

    Create ClientGateway Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ClientGateway(name: string, args: ClientGatewayArgs, opts?: CustomResourceOptions);
    @overload
def ClientGateway(resource_name: str,
                  args: ClientGatewayArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ClientGateway(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  bgp_asn: Optional[float] = None,
                  connection_type: Optional[str] = None,
                  public_ip: Optional[str] = None,
                  outscale_client_gateway_id: Optional[str] = None,
                  tags: Optional[Sequence[ClientGatewayTagArgs]] = None)
    func NewClientGateway(ctx *Context, name string, args ClientGatewayArgs, opts ...ResourceOption) (*ClientGateway, error)
    public ClientGateway(string name, ClientGatewayArgs args, CustomResourceOptions? opts = null)
    public ClientGateway(String name, ClientGatewayArgs args)
public ClientGateway(String name, ClientGatewayArgs args, CustomResourceOptions options)

    type: outscale:ClientGateway
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClientGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClientGatewayArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClientGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClientGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClientGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var clientGatewayResource = new Outscale.ClientGateway("clientGatewayResource", new()
{
    BgpAsn = 0,
    ConnectionType = "string",
    PublicIp = "string",
    OutscaleClientGatewayId = "string",
    Tags = new[]
    {
        new Outscale.Inputs.ClientGatewayTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

    example, err := outscale.NewClientGateway(ctx, "clientGatewayResource", &outscale.ClientGatewayArgs{
BgpAsn: pulumi.Float64(0),
ConnectionType: pulumi.String("string"),
PublicIp: pulumi.String("string"),
OutscaleClientGatewayId: pulumi.String("string"),
Tags: .ClientGatewayTagArray{
&.ClientGatewayTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
})

    var clientGatewayResource = new ClientGateway("clientGatewayResource", ClientGatewayArgs.builder()
    .bgpAsn(0)
    .connectionType("string")
    .publicIp("string")
    .outscaleClientGatewayId("string")
    .tags(ClientGatewayTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

    client_gateway_resource = outscale.ClientGateway("clientGatewayResource",
    bgp_asn=0,
    connection_type="string",
    public_ip="string",
    outscale_client_gateway_id="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

    const clientGatewayResource = new outscale.ClientGateway("clientGatewayResource", {
    bgpAsn: 0,
    connectionType: "string",
    publicIp: "string",
    outscaleClientGatewayId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

    type: outscale:ClientGateway
properties:
    bgpAsn: 0
    connectionType: string
    outscaleClientGatewayId: string
    publicIp: string
    tags:
        - key: string
          value: string

    ClientGateway Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ClientGateway resource accepts the following input properties:

    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    ConnectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    PublicIp string
    The public fixed IPv4 address of your client gateway.
    OutscaleClientGatewayId string
    Tags List<ClientGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    ConnectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    PublicIp string
    The public fixed IPv4 address of your client gateway.
    OutscaleClientGatewayId string
    Tags []ClientGatewayTagArgs
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    connectionType String
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    publicIp String
    The public fixed IPv4 address of your client gateway.
    outscaleClientGatewayId String
    tags List<ClientGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    connectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    publicIp string
    The public fixed IPv4 address of your client gateway.
    outscaleClientGatewayId string
    tags ClientGatewayTag[]
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    connection_type str
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    public_ip str
    The public fixed IPv4 address of your client gateway.
    outscale_client_gateway_id str
    tags Sequence[ClientGatewayTagArgs]
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    connectionType String
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    publicIp String
    The public fixed IPv4 address of your client gateway.
    outscaleClientGatewayId String
    tags List<Property Map>
    A tag to add to this resource. You can specify this argument several times.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClientGateway resource produces the following output properties:

    ClientGatewayId string
    The ID of the client gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    ClientGatewayId string
    The ID of the client gateway.
    Id string
    The provider-assigned unique ID for this managed resource.
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    clientGatewayId String
    The ID of the client gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    requestId String
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    clientGatewayId string
    The ID of the client gateway.
    id string
    The provider-assigned unique ID for this managed resource.
    requestId string
    state string
    The state of the client gateway (pending | available | deleting | deleted).
    client_gateway_id str
    The ID of the client gateway.
    id str
    The provider-assigned unique ID for this managed resource.
    request_id str
    state str
    The state of the client gateway (pending | available | deleting | deleted).
    clientGatewayId String
    The ID of the client gateway.
    id String
    The provider-assigned unique ID for this managed resource.
    requestId String
    state String
    The state of the client gateway (pending | available | deleting | deleted).

    Look up Existing ClientGateway Resource

    Get an existing ClientGateway resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClientGatewayState, opts?: CustomResourceOptions): ClientGateway
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        bgp_asn: Optional[float] = None,
        client_gateway_id: Optional[str] = None,
        connection_type: Optional[str] = None,
        outscale_client_gateway_id: Optional[str] = None,
        public_ip: Optional[str] = None,
        request_id: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Sequence[ClientGatewayTagArgs]] = None) -> ClientGateway
    func GetClientGateway(ctx *Context, name string, id IDInput, state *ClientGatewayState, opts ...ResourceOption) (*ClientGateway, error)
    public static ClientGateway Get(string name, Input<string> id, ClientGatewayState? state, CustomResourceOptions? opts = null)
    public static ClientGateway get(String name, Output<String> id, ClientGatewayState state, CustomResourceOptions options)
    resources:  _:    type: outscale:ClientGateway    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    ClientGatewayId string
    The ID of the client gateway.
    ConnectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    OutscaleClientGatewayId string
    PublicIp string
    The public fixed IPv4 address of your client gateway.
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags List<ClientGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    ClientGatewayId string
    The ID of the client gateway.
    ConnectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    OutscaleClientGatewayId string
    PublicIp string
    The public fixed IPv4 address of your client gateway.
    RequestId string
    State string
    The state of the client gateway (pending | available | deleting | deleted).
    Tags []ClientGatewayTagArgs
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    clientGatewayId String
    The ID of the client gateway.
    connectionType String
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    outscaleClientGatewayId String
    publicIp String
    The public fixed IPv4 address of your client gateway.
    requestId String
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    tags List<ClientGatewayTag>
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    clientGatewayId string
    The ID of the client gateway.
    connectionType string
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    outscaleClientGatewayId string
    publicIp string
    The public fixed IPv4 address of your client gateway.
    requestId string
    state string
    The state of the client gateway (pending | available | deleting | deleted).
    tags ClientGatewayTag[]
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    client_gateway_id str
    The ID of the client gateway.
    connection_type str
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    outscale_client_gateway_id str
    public_ip str
    The public fixed IPv4 address of your client gateway.
    request_id str
    state str
    The state of the client gateway (pending | available | deleting | deleted).
    tags Sequence[ClientGatewayTagArgs]
    A tag to add to this resource. You can specify this argument several times.
    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. This number must be between 1 and 4294967295. If you do not have an ASN, you can choose one between 64512 and 65534, or between 4200000000 and 4294967294.
    clientGatewayId String
    The ID of the client gateway.
    connectionType String
    The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
    outscaleClientGatewayId String
    publicIp String
    The public fixed IPv4 address of your client gateway.
    requestId String
    state String
    The state of the client gateway (pending | available | deleting | deleted).
    tags List<Property Map>
    A tag to add to this resource. You can specify this argument several times.

    Supporting Types

    ClientGatewayTag, ClientGatewayTagArgs

    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.

    Import

    A client gateway can be imported using its ID. For example:

    console

    $ pulumi import outscale:index/clientGateway:ClientGateway ImportedClientGateway cgw-12345678

    To learn more about importing existing cloud resources, see Importing resources.

    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