Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVpnGatewayConnection
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getIsVpnGatewayConnection

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for VPN Connection. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const example = ibm.getIsVpnGatewayConnection({
    vpnGateway: ibm_is_vpn_gateway.example.id,
    vpnGatewayConnection: ibm_is_vpn_gateway_connection.example.gateway_connection,
});
const example_1 = ibm.getIsVpnGatewayConnection({
    vpnGateway: ibm_is_vpn_gateway.example.id,
    vpnGatewayConnectionName: ibm_is_vpn_gateway_connection.example.name,
});
const example_2 = ibm.getIsVpnGatewayConnection({
    vpnGatewayName: ibm_is_vpn_gateway.example.name,
    vpnGatewayConnection: ibm_is_vpn_gateway_connection.example.gateway_connection,
});
const example_3 = ibm.getIsVpnGatewayConnection({
    vpnGatewayName: ibm_is_vpn_gateway.example.name,
    vpnGatewayConnectionName: ibm_is_vpn_gateway_connection.example.name,
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_is_vpn_gateway_connection(vpn_gateway=ibm_is_vpn_gateway["example"]["id"],
    vpn_gateway_connection=ibm_is_vpn_gateway_connection["example"]["gateway_connection"])
example_1 = ibm.get_is_vpn_gateway_connection(vpn_gateway=ibm_is_vpn_gateway["example"]["id"],
    vpn_gateway_connection_name=ibm_is_vpn_gateway_connection["example"]["name"])
example_2 = ibm.get_is_vpn_gateway_connection(vpn_gateway_name=ibm_is_vpn_gateway["example"]["name"],
    vpn_gateway_connection=ibm_is_vpn_gateway_connection["example"]["gateway_connection"])
example_3 = ibm.get_is_vpn_gateway_connection(vpn_gateway_name=ibm_is_vpn_gateway["example"]["name"],
    vpn_gateway_connection_name=ibm_is_vpn_gateway_connection["example"]["name"])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.LookupIsVpnGatewayConnection(ctx, &ibm.LookupIsVpnGatewayConnectionArgs{
			VpnGateway:           pulumi.StringRef(ibm_is_vpn_gateway.Example.Id),
			VpnGatewayConnection: pulumi.StringRef(ibm_is_vpn_gateway_connection.Example.Gateway_connection),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.LookupIsVpnGatewayConnection(ctx, &ibm.LookupIsVpnGatewayConnectionArgs{
			VpnGateway:               pulumi.StringRef(ibm_is_vpn_gateway.Example.Id),
			VpnGatewayConnectionName: pulumi.StringRef(ibm_is_vpn_gateway_connection.Example.Name),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.LookupIsVpnGatewayConnection(ctx, &ibm.LookupIsVpnGatewayConnectionArgs{
			VpnGatewayName:       pulumi.StringRef(ibm_is_vpn_gateway.Example.Name),
			VpnGatewayConnection: pulumi.StringRef(ibm_is_vpn_gateway_connection.Example.Gateway_connection),
		}, nil)
		if err != nil {
			return err
		}
		_, err = ibm.LookupIsVpnGatewayConnection(ctx, &ibm.LookupIsVpnGatewayConnectionArgs{
			VpnGatewayName:           pulumi.StringRef(ibm_is_vpn_gateway.Example.Name),
			VpnGatewayConnectionName: pulumi.StringRef(ibm_is_vpn_gateway_connection.Example.Name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var example = Ibm.GetIsVpnGatewayConnection.Invoke(new()
    {
        VpnGateway = ibm_is_vpn_gateway.Example.Id,
        VpnGatewayConnection = ibm_is_vpn_gateway_connection.Example.Gateway_connection,
    });

    var example_1 = Ibm.GetIsVpnGatewayConnection.Invoke(new()
    {
        VpnGateway = ibm_is_vpn_gateway.Example.Id,
        VpnGatewayConnectionName = ibm_is_vpn_gateway_connection.Example.Name,
    });

    var example_2 = Ibm.GetIsVpnGatewayConnection.Invoke(new()
    {
        VpnGatewayName = ibm_is_vpn_gateway.Example.Name,
        VpnGatewayConnection = ibm_is_vpn_gateway_connection.Example.Gateway_connection,
    });

    var example_3 = Ibm.GetIsVpnGatewayConnection.Invoke(new()
    {
        VpnGatewayName = ibm_is_vpn_gateway.Example.Name,
        VpnGatewayConnectionName = ibm_is_vpn_gateway_connection.Example.Name,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetIsVpnGatewayConnectionArgs;
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 example = IbmFunctions.getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs.builder()
            .vpnGateway(ibm_is_vpn_gateway.example().id())
            .vpnGatewayConnection(ibm_is_vpn_gateway_connection.example().gateway_connection())
            .build());

        final var example-1 = IbmFunctions.getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs.builder()
            .vpnGateway(ibm_is_vpn_gateway.example().id())
            .vpnGatewayConnectionName(ibm_is_vpn_gateway_connection.example().name())
            .build());

        final var example-2 = IbmFunctions.getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs.builder()
            .vpnGatewayName(ibm_is_vpn_gateway.example().name())
            .vpnGatewayConnection(ibm_is_vpn_gateway_connection.example().gateway_connection())
            .build());

        final var example-3 = IbmFunctions.getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs.builder()
            .vpnGatewayName(ibm_is_vpn_gateway.example().name())
            .vpnGatewayConnectionName(ibm_is_vpn_gateway_connection.example().name())
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getIsVpnGatewayConnection
      arguments:
        vpnGateway: ${ibm_is_vpn_gateway.example.id}
        vpnGatewayConnection: ${ibm_is_vpn_gateway_connection.example.gateway_connection}
  example-1:
    fn::invoke:
      function: ibm:getIsVpnGatewayConnection
      arguments:
        vpnGateway: ${ibm_is_vpn_gateway.example.id}
        vpnGatewayConnectionName: ${ibm_is_vpn_gateway_connection.example.name}
  example-2:
    fn::invoke:
      function: ibm:getIsVpnGatewayConnection
      arguments:
        vpnGatewayName: ${ibm_is_vpn_gateway.example.name}
        vpnGatewayConnection: ${ibm_is_vpn_gateway_connection.example.gateway_connection}
  example-3:
    fn::invoke:
      function: ibm:getIsVpnGatewayConnection
      arguments:
        vpnGatewayName: ${ibm_is_vpn_gateway.example.name}
        vpnGatewayConnectionName: ${ibm_is_vpn_gateway_connection.example.name}

    Using getIsVpnGatewayConnection

    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 getIsVpnGatewayConnection(args: GetIsVpnGatewayConnectionArgs, opts?: InvokeOptions): Promise<GetIsVpnGatewayConnectionResult>
function getIsVpnGatewayConnectionOutput(args: GetIsVpnGatewayConnectionOutputArgs, opts?: InvokeOptions): Output<GetIsVpnGatewayConnectionResult>
    def get_is_vpn_gateway_connection(id: Optional[str] = None,
                                  vpn_gateway: Optional[str] = None,
                                  vpn_gateway_connection: Optional[str] = None,
                                  vpn_gateway_connection_name: Optional[str] = None,
                                  vpn_gateway_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetIsVpnGatewayConnectionResult
def get_is_vpn_gateway_connection_output(id: Optional[pulumi.Input[str]] = None,
                                  vpn_gateway: Optional[pulumi.Input[str]] = None,
                                  vpn_gateway_connection: Optional[pulumi.Input[str]] = None,
                                  vpn_gateway_connection_name: Optional[pulumi.Input[str]] = None,
                                  vpn_gateway_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnGatewayConnectionResult]
    func LookupIsVpnGatewayConnection(ctx *Context, args *LookupIsVpnGatewayConnectionArgs, opts ...InvokeOption) (*LookupIsVpnGatewayConnectionResult, error)
func LookupIsVpnGatewayConnectionOutput(ctx *Context, args *LookupIsVpnGatewayConnectionOutputArgs, opts ...InvokeOption) LookupIsVpnGatewayConnectionResultOutput

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

    public static class GetIsVpnGatewayConnection 
{
    public static Task<GetIsVpnGatewayConnectionResult> InvokeAsync(GetIsVpnGatewayConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetIsVpnGatewayConnectionResult> Invoke(GetIsVpnGatewayConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIsVpnGatewayConnectionResult> getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs args, InvokeOptions options)
public static Output<GetIsVpnGatewayConnectionResult> getIsVpnGatewayConnection(GetIsVpnGatewayConnectionArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getIsVpnGatewayConnection:getIsVpnGatewayConnection
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    (String) The unique identifier for this IPsec policy.
    VpnGateway string
    The VPN gateway identifier.
    VpnGatewayConnection string
    The VPN gateway connection identifier.
    VpnGatewayConnectionName string

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    VpnGatewayName string
    The VPN gateway name.
    Id string
    (String) The unique identifier for this IPsec policy.
    VpnGateway string
    The VPN gateway identifier.
    VpnGatewayConnection string
    The VPN gateway connection identifier.
    VpnGatewayConnectionName string

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    VpnGatewayName string
    The VPN gateway name.
    id String
    (String) The unique identifier for this IPsec policy.
    vpnGateway String
    The VPN gateway identifier.
    vpnGatewayConnection String
    The VPN gateway connection identifier.
    vpnGatewayConnectionName String

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    vpnGatewayName String
    The VPN gateway name.
    id string
    (String) The unique identifier for this IPsec policy.
    vpnGateway string
    The VPN gateway identifier.
    vpnGatewayConnection string
    The VPN gateway connection identifier.
    vpnGatewayConnectionName string

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    vpnGatewayName string
    The VPN gateway name.
    id str
    (String) The unique identifier for this IPsec policy.
    vpn_gateway str
    The VPN gateway identifier.
    vpn_gateway_connection str
    The VPN gateway connection identifier.
    vpn_gateway_connection_name str

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    vpn_gateway_name str
    The VPN gateway name.
    id String
    (String) The unique identifier for this IPsec policy.
    vpnGateway String
    The VPN gateway identifier.
    vpnGatewayConnection String
    The VPN gateway connection identifier.
    vpnGatewayConnectionName String

    The VPN gateway connection name.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway and either one of vpn_gateway_connection, vpn_gateway_connection_name to identify vpn gateway connection.

    vpnGatewayName String
    The VPN gateway name.

    getIsVpnGatewayConnection Result

    The following output properties are available:

    AdminStateUp bool
    (Boolean) If set to false, the VPN gateway connection is shut down.
    AuthenticationMode string
    (String) The authentication mode. Only psk is currently supported.
    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    DeadPeerDetections List<GetIsVpnGatewayConnectionDeadPeerDetection>
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    DistributeTraffic bool
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    EstablishMode string
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    IkePolicies List<GetIsVpnGatewayConnectionIkePolicy>
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    IpsecPolicies List<GetIsVpnGatewayConnectionIpsecPolicy>
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    LocalCidrs List<string>
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    Locals List<GetIsVpnGatewayConnectionLocal>
    (List) Nested schema for local:
    Mode string
    (String) The mode of the VPN gateway.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    PeerAddress string
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    PeerCidrs List<string>
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    Peers List<GetIsVpnGatewayConnectionPeer>
    (List) Nested schema for peer:
    Psk string
    (String) The preshared key.
    ResourceType string
    (String) The resource type.
    RoutingProtocol string
    (String) Routing protocols are disabled for this VPN gateway connection.
    Status string
    (String) The status of the VPN Tunnel.
    StatusReasons List<GetIsVpnGatewayConnectionStatusReason>
    (List) Array of reasons for the current status (if any).
    Tunnels List<GetIsVpnGatewayConnectionTunnel>
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    VpnGateway string
    VpnGatewayConnection string
    VpnGatewayConnectionName string
    VpnGatewayName string
    AdminStateUp bool
    (Boolean) If set to false, the VPN gateway connection is shut down.
    AuthenticationMode string
    (String) The authentication mode. Only psk is currently supported.
    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    DeadPeerDetections []GetIsVpnGatewayConnectionDeadPeerDetection
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    DistributeTraffic bool
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    EstablishMode string
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    IkePolicies []GetIsVpnGatewayConnectionIkePolicy
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    IpsecPolicies []GetIsVpnGatewayConnectionIpsecPolicy
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    LocalCidrs []string
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    Locals []GetIsVpnGatewayConnectionLocal
    (List) Nested schema for local:
    Mode string
    (String) The mode of the VPN gateway.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    PeerAddress string
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    PeerCidrs []string
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    Peers []GetIsVpnGatewayConnectionPeer
    (List) Nested schema for peer:
    Psk string
    (String) The preshared key.
    ResourceType string
    (String) The resource type.
    RoutingProtocol string
    (String) Routing protocols are disabled for this VPN gateway connection.
    Status string
    (String) The status of the VPN Tunnel.
    StatusReasons []GetIsVpnGatewayConnectionStatusReason
    (List) Array of reasons for the current status (if any).
    Tunnels []GetIsVpnGatewayConnectionTunnel
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    VpnGateway string
    VpnGatewayConnection string
    VpnGatewayConnectionName string
    VpnGatewayName string
    adminStateUp Boolean
    (Boolean) If set to false, the VPN gateway connection is shut down.
    authenticationMode String
    (String) The authentication mode. Only psk is currently supported.
    createdAt String
    (String) The date and time that this VPN gateway connection was created.
    deadPeerDetections List<GetIsVpnGatewayConnectionDeadPeerDetection>
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    distributeTraffic Boolean
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    establishMode String
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    ikePolicies List<GetIsVpnGatewayConnectionIkePolicy>
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    ipsecPolicies List<GetIsVpnGatewayConnectionIpsecPolicy>
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    localCidrs List<String>
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    locals List<GetIsVpnGatewayConnectionLocal>
    (List) Nested schema for local:
    mode String
    (String) The mode of the VPN gateway.
    name String
    (String) The user-defined name for this VPN gateway connection.
    peerAddress String
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    peerCidrs List<String>
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    peers List<GetIsVpnGatewayConnectionPeer>
    (List) Nested schema for peer:
    psk String
    (String) The preshared key.
    resourceType String
    (String) The resource type.
    routingProtocol String
    (String) Routing protocols are disabled for this VPN gateway connection.
    status String
    (String) The status of the VPN Tunnel.
    statusReasons List<GetIsVpnGatewayConnectionStatusReason>
    (List) Array of reasons for the current status (if any).
    tunnels List<GetIsVpnGatewayConnectionTunnel>
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    vpnGateway String
    vpnGatewayConnection String
    vpnGatewayConnectionName String
    vpnGatewayName String
    adminStateUp boolean
    (Boolean) If set to false, the VPN gateway connection is shut down.
    authenticationMode string
    (String) The authentication mode. Only psk is currently supported.
    createdAt string
    (String) The date and time that this VPN gateway connection was created.
    deadPeerDetections GetIsVpnGatewayConnectionDeadPeerDetection[]
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    distributeTraffic boolean
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    establishMode string
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    href string
    (String) The IPsec policy's canonical URL.
    id string
    (String) The unique identifier for this IPsec policy.
    ikePolicies GetIsVpnGatewayConnectionIkePolicy[]
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    ipsecPolicies GetIsVpnGatewayConnectionIpsecPolicy[]
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    localCidrs string[]
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    locals GetIsVpnGatewayConnectionLocal[]
    (List) Nested schema for local:
    mode string
    (String) The mode of the VPN gateway.
    name string
    (String) The user-defined name for this VPN gateway connection.
    peerAddress string
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    peerCidrs string[]
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    peers GetIsVpnGatewayConnectionPeer[]
    (List) Nested schema for peer:
    psk string
    (String) The preshared key.
    resourceType string
    (String) The resource type.
    routingProtocol string
    (String) Routing protocols are disabled for this VPN gateway connection.
    status string
    (String) The status of the VPN Tunnel.
    statusReasons GetIsVpnGatewayConnectionStatusReason[]
    (List) Array of reasons for the current status (if any).
    tunnels GetIsVpnGatewayConnectionTunnel[]
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    vpnGateway string
    vpnGatewayConnection string
    vpnGatewayConnectionName string
    vpnGatewayName string
    admin_state_up bool
    (Boolean) If set to false, the VPN gateway connection is shut down.
    authentication_mode str
    (String) The authentication mode. Only psk is currently supported.
    created_at str
    (String) The date and time that this VPN gateway connection was created.
    dead_peer_detections Sequence[GetIsVpnGatewayConnectionDeadPeerDetection]
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    distribute_traffic bool
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    establish_mode str
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    href str
    (String) The IPsec policy's canonical URL.
    id str
    (String) The unique identifier for this IPsec policy.
    ike_policies Sequence[GetIsVpnGatewayConnectionIkePolicy]
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    ipsec_policies Sequence[GetIsVpnGatewayConnectionIpsecPolicy]
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    local_cidrs Sequence[str]
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    locals Sequence[GetIsVpnGatewayConnectionLocal]
    (List) Nested schema for local:
    mode str
    (String) The mode of the VPN gateway.
    name str
    (String) The user-defined name for this VPN gateway connection.
    peer_address str
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    peer_cidrs Sequence[str]
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    peers Sequence[GetIsVpnGatewayConnectionPeer]
    (List) Nested schema for peer:
    psk str
    (String) The preshared key.
    resource_type str
    (String) The resource type.
    routing_protocol str
    (String) Routing protocols are disabled for this VPN gateway connection.
    status str
    (String) The status of the VPN Tunnel.
    status_reasons Sequence[GetIsVpnGatewayConnectionStatusReason]
    (List) Array of reasons for the current status (if any).
    tunnels Sequence[GetIsVpnGatewayConnectionTunnel]
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    vpn_gateway str
    vpn_gateway_connection str
    vpn_gateway_connection_name str
    vpn_gateway_name str
    adminStateUp Boolean
    (Boolean) If set to false, the VPN gateway connection is shut down.
    authenticationMode String
    (String) The authentication mode. Only psk is currently supported.
    createdAt String
    (String) The date and time that this VPN gateway connection was created.
    deadPeerDetections List<Property Map>
    (List) The Dead Peer Detection settings. Nested scheme for dead_peer_detection:
    distributeTraffic Boolean
    (Boolean) Indicates whether the traffic is distributed between the up tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If false, the traffic is only routed through the up tunnel with the lower public_ip address. Distributing traffic across tunnels of route-based VPN gateway connections. Traffic across tunnels can be distributed with a status of up in a route-based VPN gateway connection. When creating or updating a route-based VPN gateway connection, set the distribute_traffic property to true (default is false). Existing connections will have the distribute_traffic property set to false.
    establishMode String
    (String) The establish mode of the VPN gateway connection:- bidirectional: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes.- peer_only: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    ikePolicies List<Property Map>
    (List) The IKE policy. If absent, auto-negotiation isused. Nested scheme for ike_policy:
    ipsecPolicies List<Property Map>
    (List) The IPsec policy. If absent, auto-negotiation isused. Nested scheme for ipsec_policy:
    localCidrs List<String>
    (List) The local CIDRs for this resource.

    Deprecated: Deprecated

    locals List<Property Map>
    (List) Nested schema for local:
    mode String
    (String) The mode of the VPN gateway.
    name String
    (String) The user-defined name for this VPN gateway connection.
    peerAddress String
    (String) The IP address of the peer VPN gateway.

    Deprecated: Deprecated

    peerCidrs List<String>
    (List) The peer CIDRs for this resource.

    Deprecated: Deprecated

    peers List<Property Map>
    (List) Nested schema for peer:
    psk String
    (String) The preshared key.
    resourceType String
    (String) The resource type.
    routingProtocol String
    (String) Routing protocols are disabled for this VPN gateway connection.
    status String
    (String) The status of the VPN Tunnel.
    statusReasons List<Property Map>
    (List) Array of reasons for the current status (if any).
    tunnels List<Property Map>
    (List) The VPN tunnel configuration for this VPN gateway connection (in static route mode). Nested scheme for tunnels:
    vpnGateway String
    vpnGatewayConnection String
    vpnGatewayConnectionName String
    vpnGatewayName String

    Supporting Types

    GetIsVpnGatewayConnectionDeadPeerDetection

    Action string
    (String) Dead Peer Detection actions.
    Interval double
    (Integer) Dead Peer Detection interval in seconds.
    Timeout double
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.
    Action string
    (String) Dead Peer Detection actions.
    Interval float64
    (Integer) Dead Peer Detection interval in seconds.
    Timeout float64
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.
    action String
    (String) Dead Peer Detection actions.
    interval Double
    (Integer) Dead Peer Detection interval in seconds.
    timeout Double
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.
    action string
    (String) Dead Peer Detection actions.
    interval number
    (Integer) Dead Peer Detection interval in seconds.
    timeout number
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.
    action str
    (String) Dead Peer Detection actions.
    interval float
    (Integer) Dead Peer Detection interval in seconds.
    timeout float
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.
    action String
    (String) Dead Peer Detection actions.
    interval Number
    (Integer) Dead Peer Detection interval in seconds.
    timeout Number
    (Integer) Dead Peer Detection timeout in seconds. Must be at least the interval.

    GetIsVpnGatewayConnectionIkePolicy

    Deleteds List<GetIsVpnGatewayConnectionIkePolicyDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    ResourceType string
    (String) The resource type.
    Deleteds []GetIsVpnGatewayConnectionIkePolicyDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    ResourceType string
    (String) The resource type.
    deleteds List<GetIsVpnGatewayConnectionIkePolicyDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    name String
    (String) The user-defined name for this VPN gateway connection.
    resourceType String
    (String) The resource type.
    deleteds GetIsVpnGatewayConnectionIkePolicyDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href string
    (String) The IPsec policy's canonical URL.
    id string
    (String) The unique identifier for this IPsec policy.
    name string
    (String) The user-defined name for this VPN gateway connection.
    resourceType string
    (String) The resource type.
    deleteds Sequence[GetIsVpnGatewayConnectionIkePolicyDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href str
    (String) The IPsec policy's canonical URL.
    id str
    (String) The unique identifier for this IPsec policy.
    name str
    (String) The user-defined name for this VPN gateway connection.
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    name String
    (String) The user-defined name for this VPN gateway connection.
    resourceType String
    (String) The resource type.

    GetIsVpnGatewayConnectionIkePolicyDeleted

    MoreInfo string
    (String) Link to documentation about this status reason
    MoreInfo string
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason
    moreInfo string
    (String) Link to documentation about this status reason
    more_info str
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason

    GetIsVpnGatewayConnectionIpsecPolicy

    Deleteds List<GetIsVpnGatewayConnectionIpsecPolicyDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    ResourceType string
    (String) The resource type.
    Deleteds []GetIsVpnGatewayConnectionIpsecPolicyDeleted
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    Href string
    (String) The IPsec policy's canonical URL.
    Id string
    (String) The unique identifier for this IPsec policy.
    Name string
    (String) The user-defined name for this VPN gateway connection.
    ResourceType string
    (String) The resource type.
    deleteds List<GetIsVpnGatewayConnectionIpsecPolicyDeleted>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    name String
    (String) The user-defined name for this VPN gateway connection.
    resourceType String
    (String) The resource type.
    deleteds GetIsVpnGatewayConnectionIpsecPolicyDeleted[]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href string
    (String) The IPsec policy's canonical URL.
    id string
    (String) The unique identifier for this IPsec policy.
    name string
    (String) The user-defined name for this VPN gateway connection.
    resourceType string
    (String) The resource type.
    deleteds Sequence[GetIsVpnGatewayConnectionIpsecPolicyDeleted]
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href str
    (String) The IPsec policy's canonical URL.
    id str
    (String) The unique identifier for this IPsec policy.
    name str
    (String) The user-defined name for this VPN gateway connection.
    resource_type str
    (String) The resource type.
    deleteds List<Property Map>
    (List) If present, this property indicates the referenced resource has been deleted and provides some supplementary information. Nested scheme for deleted:
    href String
    (String) The IPsec policy's canonical URL.
    id String
    (String) The unique identifier for this IPsec policy.
    name String
    (String) The user-defined name for this VPN gateway connection.
    resourceType String
    (String) The resource type.

    GetIsVpnGatewayConnectionIpsecPolicyDeleted

    MoreInfo string
    (String) Link to documentation about this status reason
    MoreInfo string
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason
    moreInfo string
    (String) Link to documentation about this status reason
    more_info str
    (String) Link to documentation about this status reason
    moreInfo String
    (String) Link to documentation about this status reason

    GetIsVpnGatewayConnectionLocal

    Cidrs List<string>
    IkeIdentities List<GetIsVpnGatewayConnectionLocalIkeIdentity>
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
    Cidrs []string
    IkeIdentities []GetIsVpnGatewayConnectionLocalIkeIdentity
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
    cidrs List<String>
    ikeIdentities List<GetIsVpnGatewayConnectionLocalIkeIdentity>
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
    cidrs string[]
    ikeIdentities GetIsVpnGatewayConnectionLocalIkeIdentity[]
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
    cidrs Sequence[str]
    ike_identities Sequence[GetIsVpnGatewayConnectionLocalIkeIdentity]
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:
    cidrs List<String>
    ikeIdentities List<Property Map>
    (List) The local IKE identities.A VPN gateway in static route mode consists of two members in active-active mode. The first identity applies to the first member, and the second identity applies to the second member. Nested schema for ike_identities:

    GetIsVpnGatewayConnectionLocalIkeIdentity

    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    Value string
    (String) The IKE identity FQDN value.
    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    Value string
    (String) The IKE identity FQDN value.
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.
    value String
    (String) The IKE identity FQDN value.
    type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    value string
    (String) The IKE identity FQDN value.
    type str
    (String) Indicates whether peer.address or peer.fqdn is used.
    value str
    (String) The IKE identity FQDN value.
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.
    value String
    (String) The IKE identity FQDN value.

    GetIsVpnGatewayConnectionPeer

    Address string
    (String) The IP address of the peer VPN gateway for this connection.
    Cidrs List<string>
    Fqdn string
    (String) The FQDN of the peer VPN gateway for this connection.
    IkeIdentities List<GetIsVpnGatewayConnectionPeerIkeIdentity>
    (List) The peer IKE identity. Nested schema for ike_identity:
    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    Address string
    (String) The IP address of the peer VPN gateway for this connection.
    Cidrs []string
    Fqdn string
    (String) The FQDN of the peer VPN gateway for this connection.
    IkeIdentities []GetIsVpnGatewayConnectionPeerIkeIdentity
    (List) The peer IKE identity. Nested schema for ike_identity:
    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    address String
    (String) The IP address of the peer VPN gateway for this connection.
    cidrs List<String>
    fqdn String
    (String) The FQDN of the peer VPN gateway for this connection.
    ikeIdentities List<GetIsVpnGatewayConnectionPeerIkeIdentity>
    (List) The peer IKE identity. Nested schema for ike_identity:
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.
    address string
    (String) The IP address of the peer VPN gateway for this connection.
    cidrs string[]
    fqdn string
    (String) The FQDN of the peer VPN gateway for this connection.
    ikeIdentities GetIsVpnGatewayConnectionPeerIkeIdentity[]
    (List) The peer IKE identity. Nested schema for ike_identity:
    type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    address str
    (String) The IP address of the peer VPN gateway for this connection.
    cidrs Sequence[str]
    fqdn str
    (String) The FQDN of the peer VPN gateway for this connection.
    ike_identities Sequence[GetIsVpnGatewayConnectionPeerIkeIdentity]
    (List) The peer IKE identity. Nested schema for ike_identity:
    type str
    (String) Indicates whether peer.address or peer.fqdn is used.
    address String
    (String) The IP address of the peer VPN gateway for this connection.
    cidrs List<String>
    fqdn String
    (String) The FQDN of the peer VPN gateway for this connection.
    ikeIdentities List<Property Map>
    (List) The peer IKE identity. Nested schema for ike_identity:
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.

    GetIsVpnGatewayConnectionPeerIkeIdentity

    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    Value string
    (String) The IKE identity FQDN value.
    Type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    Value string
    (String) The IKE identity FQDN value.
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.
    value String
    (String) The IKE identity FQDN value.
    type string
    (String) Indicates whether peer.address or peer.fqdn is used.
    value string
    (String) The IKE identity FQDN value.
    type str
    (String) Indicates whether peer.address or peer.fqdn is used.
    value str
    (String) The IKE identity FQDN value.
    type String
    (String) Indicates whether peer.address or peer.fqdn is used.
    value String
    (String) The IKE identity FQDN value.

    GetIsVpnGatewayConnectionStatusReason

    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the status reason.
    MoreInfo string
    (String) Link to documentation about this status reason
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason
    code string
    (String) The status reason code.
    message string
    (String) An explanation of the status reason.
    moreInfo string
    (String) Link to documentation about this status reason
    code str
    (String) The status reason code.
    message str
    (String) An explanation of the status reason.
    more_info str
    (String) Link to documentation about this status reason
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the status reason.
    moreInfo String
    (String) Link to documentation about this status reason

    GetIsVpnGatewayConnectionTunnel

    PublicIpAddress string
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Status string
    (String) The status of the VPN Tunnel.
    PublicIpAddress string
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    Status string
    (String) The status of the VPN Tunnel.
    publicIpAddress String
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    status String
    (String) The status of the VPN Tunnel.
    publicIpAddress string
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    status string
    (String) The status of the VPN Tunnel.
    public_ip_address str
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    status str
    (String) The status of the VPN Tunnel.
    publicIpAddress String
    (String) The IP address of the VPN gateway member in which the tunnel resides. This property may add support for IPv6 addresses in the future. When processing a value in this property, verify that the address is in an expected format. If it is not, log an error. Optionally halt processing and surface the error, or bypass the resource on which the unexpected IP address format was encountered.
    status String
    (String) The status of the VPN Tunnel.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm