1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVpnGatewayServiceConnections
ibm 1.86.0 published on Wednesday, Dec 3, 2025 by ibm-cloud
ibm logo
ibm 1.86.0 published on Wednesday, Dec 3, 2025 by ibm-cloud

    Retrieve information of an existing VPN gateway connections. For more information, see adding connections to a VPN gateway.

    Note: VPC infrastructure services are a regional specific based endpoint, by default targets to us-south. Please make sure to target right region in the provider block as shown in the provider.tf file, if VPC service is created in region other than us-south.

    provider.tf

    import * as pulumi from "@pulumi/pulumi";
    
    import pulumi
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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) {
        }
    }
    
    {}
    

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const example = ibm.getIsVpnGatewayServiceConnections({
        vpnGateway: exampleIbmIsVpnGateway.id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_vpn_gateway_service_connections(vpn_gateway=example_ibm_is_vpn_gateway["id"])
    
    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.GetIsVpnGatewayServiceConnections(ctx, &ibm.GetIsVpnGatewayServiceConnectionsArgs{
    			VpnGateway: exampleIbmIsVpnGateway.Id,
    		}, 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.GetIsVpnGatewayServiceConnections.Invoke(new()
        {
            VpnGateway = exampleIbmIsVpnGateway.Id,
        });
    
    });
    
    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.GetIsVpnGatewayServiceConnectionsArgs;
    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.getIsVpnGatewayServiceConnections(GetIsVpnGatewayServiceConnectionsArgs.builder()
                .vpnGateway(exampleIbmIsVpnGateway.id())
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsVpnGatewayServiceConnections
          arguments:
            vpnGateway: ${exampleIbmIsVpnGateway.id}
    

    Using getIsVpnGatewayServiceConnections

    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 getIsVpnGatewayServiceConnections(args: GetIsVpnGatewayServiceConnectionsArgs, opts?: InvokeOptions): Promise<GetIsVpnGatewayServiceConnectionsResult>
    function getIsVpnGatewayServiceConnectionsOutput(args: GetIsVpnGatewayServiceConnectionsOutputArgs, opts?: InvokeOptions): Output<GetIsVpnGatewayServiceConnectionsResult>
    def get_is_vpn_gateway_service_connections(id: Optional[str] = None,
                                               vpn_gateway: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetIsVpnGatewayServiceConnectionsResult
    def get_is_vpn_gateway_service_connections_output(id: Optional[pulumi.Input[str]] = None,
                                               vpn_gateway: Optional[pulumi.Input[str]] = None,
                                               opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnGatewayServiceConnectionsResult]
    func GetIsVpnGatewayServiceConnections(ctx *Context, args *GetIsVpnGatewayServiceConnectionsArgs, opts ...InvokeOption) (*GetIsVpnGatewayServiceConnectionsResult, error)
    func GetIsVpnGatewayServiceConnectionsOutput(ctx *Context, args *GetIsVpnGatewayServiceConnectionsOutputArgs, opts ...InvokeOption) GetIsVpnGatewayServiceConnectionsResultOutput

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

    public static class GetIsVpnGatewayServiceConnections 
    {
        public static Task<GetIsVpnGatewayServiceConnectionsResult> InvokeAsync(GetIsVpnGatewayServiceConnectionsArgs args, InvokeOptions? opts = null)
        public static Output<GetIsVpnGatewayServiceConnectionsResult> Invoke(GetIsVpnGatewayServiceConnectionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsVpnGatewayServiceConnectionsResult> getIsVpnGatewayServiceConnections(GetIsVpnGatewayServiceConnectionsArgs args, InvokeOptions options)
    public static Output<GetIsVpnGatewayServiceConnectionsResult> getIsVpnGatewayServiceConnections(GetIsVpnGatewayServiceConnectionsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsVpnGatewayServiceConnections:getIsVpnGatewayServiceConnections
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VpnGateway string
    The VPN gateway ID.
    Id string
    The unique identifier for this VPN gateway service connection.
    VpnGateway string
    The VPN gateway ID.
    Id string
    The unique identifier for this VPN gateway service connection.
    vpnGateway String
    The VPN gateway ID.
    id String
    The unique identifier for this VPN gateway service connection.
    vpnGateway string
    The VPN gateway ID.
    id string
    The unique identifier for this VPN gateway service connection.
    vpn_gateway str
    The VPN gateway ID.
    id str
    The unique identifier for this VPN gateway service connection.
    vpnGateway String
    The VPN gateway ID.
    id String
    The unique identifier for this VPN gateway service connection.

    getIsVpnGatewayServiceConnections Result

    The following output properties are available:

    Id string
    The unique identifier for this VPN gateway service connection.
    ServiceConnections List<GetIsVpnGatewayServiceConnectionsServiceConnection>
    (List) List VPN gateway service connections.
    VpnGateway string
    Id string
    The unique identifier for this VPN gateway service connection.
    ServiceConnections []GetIsVpnGatewayServiceConnectionsServiceConnection
    (List) List VPN gateway service connections.
    VpnGateway string
    id String
    The unique identifier for this VPN gateway service connection.
    serviceConnections List<GetIsVpnGatewayServiceConnectionsServiceConnection>
    (List) List VPN gateway service connections.
    vpnGateway String
    id string
    The unique identifier for this VPN gateway service connection.
    serviceConnections GetIsVpnGatewayServiceConnectionsServiceConnection[]
    (List) List VPN gateway service connections.
    vpnGateway string
    id str
    The unique identifier for this VPN gateway service connection.
    service_connections Sequence[GetIsVpnGatewayServiceConnectionsServiceConnection]
    (List) List VPN gateway service connections.
    vpn_gateway str
    id String
    The unique identifier for this VPN gateway service connection.
    serviceConnections List<Property Map>
    (List) List VPN gateway service connections.
    vpnGateway String

    Supporting Types

    GetIsVpnGatewayServiceConnectionsServiceConnection

    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    Creators List<GetIsVpnGatewayServiceConnectionsServiceConnectionCreator>
    (List) Nested scheme for creator:
    Id string
    The unique identifier for this VPN gateway service connection.
    LifecycleReasons List<GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason>
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    LifecycleState string
    (List) The lifecycle state of the VPN service connection.
    Status string
    (String) The status of this service connection.
    StatusReasons List<GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason>
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    Creators []GetIsVpnGatewayServiceConnectionsServiceConnectionCreator
    (List) Nested scheme for creator:
    Id string
    The unique identifier for this VPN gateway service connection.
    LifecycleReasons []GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    LifecycleState string
    (List) The lifecycle state of the VPN service connection.
    Status string
    (String) The status of this service connection.
    StatusReasons []GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    createdAt String
    (String) The date and time that this VPN gateway connection was created.
    creators List<GetIsVpnGatewayServiceConnectionsServiceConnectionCreator>
    (List) Nested scheme for creator:
    id String
    The unique identifier for this VPN gateway service connection.
    lifecycleReasons List<GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason>
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    lifecycleState String
    (List) The lifecycle state of the VPN service connection.
    status String
    (String) The status of this service connection.
    statusReasons List<GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason>
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    createdAt string
    (String) The date and time that this VPN gateway connection was created.
    creators GetIsVpnGatewayServiceConnectionsServiceConnectionCreator[]
    (List) Nested scheme for creator:
    id string
    The unique identifier for this VPN gateway service connection.
    lifecycleReasons GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason[]
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    lifecycleState string
    (List) The lifecycle state of the VPN service connection.
    status string
    (String) The status of this service connection.
    statusReasons GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason[]
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    created_at str
    (String) The date and time that this VPN gateway connection was created.
    creators Sequence[GetIsVpnGatewayServiceConnectionsServiceConnectionCreator]
    (List) Nested scheme for creator:
    id str
    The unique identifier for this VPN gateway service connection.
    lifecycle_reasons Sequence[GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason]
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    lifecycle_state str
    (List) The lifecycle state of the VPN service connection.
    status str
    (String) The status of this service connection.
    status_reasons Sequence[GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason]
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    createdAt String
    (String) The date and time that this VPN gateway connection was created.
    creators List<Property Map>
    (List) Nested scheme for creator:
    id String
    The unique identifier for this VPN gateway service connection.
    lifecycleReasons List<Property Map>
    (List) The reasons for the current lifecycle_state (if any). Nested scheme for lifecycle_reasons:
    lifecycleState String
    (List) The lifecycle state of the VPN service connection.
    status String
    (String) The status of this service connection.
    statusReasons List<Property Map>
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:

    GetIsVpnGatewayServiceConnectionsServiceConnectionCreator

    Crn string
    (String) The CRN for this transit gateway.
    Id string
    The unique identifier for this VPN gateway service connection.
    ResourceType string
    (String) The resource type.
    Crn string
    (String) The CRN for this transit gateway.
    Id string
    The unique identifier for this VPN gateway service connection.
    ResourceType string
    (String) The resource type.
    crn String
    (String) The CRN for this transit gateway.
    id String
    The unique identifier for this VPN gateway service connection.
    resourceType String
    (String) The resource type.
    crn string
    (String) The CRN for this transit gateway.
    id string
    The unique identifier for this VPN gateway service connection.
    resourceType string
    (String) The resource type.
    crn str
    (String) The CRN for this transit gateway.
    id str
    The unique identifier for this VPN gateway service connection.
    resource_type str
    (String) The resource type.
    crn String
    (String) The CRN for this transit gateway.
    id String
    The unique identifier for this VPN gateway service connection.
    resourceType String
    (String) The resource type.

    GetIsVpnGatewayServiceConnectionsServiceConnectionLifecycleReason

    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the reason for this VPN service connection's status.
    MoreInfo string
    (String) Link to documentation about this status reason
    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the reason for this VPN service connection's status.
    MoreInfo string
    (String) Link to documentation about this status reason
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the reason for this VPN service connection's status.
    moreInfo String
    (String) Link to documentation about this status reason
    code string
    (String) The status reason code.
    message string
    (String) An explanation of the reason for this VPN service connection's status.
    moreInfo string
    (String) Link to documentation about this status reason
    code str
    (String) The status reason code.
    message str
    (String) An explanation of the reason for this VPN service connection's status.
    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 reason for this VPN service connection's status.
    moreInfo String
    (String) Link to documentation about this status reason

    GetIsVpnGatewayServiceConnectionsServiceConnectionStatusReason

    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the reason for this VPN service connection's status.
    MoreInfo string
    (String) Link to documentation about this status reason
    Code string
    (String) The status reason code.
    Message string
    (String) An explanation of the reason for this VPN service connection's status.
    MoreInfo string
    (String) Link to documentation about this status reason
    code String
    (String) The status reason code.
    message String
    (String) An explanation of the reason for this VPN service connection's status.
    moreInfo String
    (String) Link to documentation about this status reason
    code string
    (String) The status reason code.
    message string
    (String) An explanation of the reason for this VPN service connection's status.
    moreInfo string
    (String) Link to documentation about this status reason
    code str
    (String) The status reason code.
    message str
    (String) An explanation of the reason for this VPN service connection's status.
    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 reason for this VPN service connection's status.
    moreInfo String
    (String) Link to documentation about this status reason

    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.86.0 published on Wednesday, Dec 3, 2025 by ibm-cloud
      Meet Neo: Your AI Platform Teammate