1. Packages
  2. Ibm Provider
  3. API Docs
  4. getIsVpnGatewayServiceConnection
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

    Provides a read-only data source for VPN gateway service 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.getIsVpnGatewayServiceConnection({
        vpnGateway: exampleIbmIsVpnGateway.id,
        vpnGatewayServiceConnection: "3066f374-97f7-4138-b59d-20a8414f49a8",
    });
    const example_1 = ibm.getIsVpnGatewayServiceConnection({
        vpnGatewayName: exampleIbmIsVpnGateway.name,
        vpnGatewayServiceConnection: "3066f374-97f7-4138-b59d-20a8414f49a8",
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    example = ibm.get_is_vpn_gateway_service_connection(vpn_gateway=example_ibm_is_vpn_gateway["id"],
        vpn_gateway_service_connection="3066f374-97f7-4138-b59d-20a8414f49a8")
    example_1 = ibm.get_is_vpn_gateway_service_connection(vpn_gateway_name=example_ibm_is_vpn_gateway["name"],
        vpn_gateway_service_connection="3066f374-97f7-4138-b59d-20a8414f49a8")
    
    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.GetIsVpnGatewayServiceConnection(ctx, &ibm.GetIsVpnGatewayServiceConnectionArgs{
    			VpnGateway:                  pulumi.StringRef(exampleIbmIsVpnGateway.Id),
    			VpnGatewayServiceConnection: "3066f374-97f7-4138-b59d-20a8414f49a8",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = ibm.GetIsVpnGatewayServiceConnection(ctx, &ibm.GetIsVpnGatewayServiceConnectionArgs{
    			VpnGatewayName:              pulumi.StringRef(exampleIbmIsVpnGateway.Name),
    			VpnGatewayServiceConnection: "3066f374-97f7-4138-b59d-20a8414f49a8",
    		}, 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.GetIsVpnGatewayServiceConnection.Invoke(new()
        {
            VpnGateway = exampleIbmIsVpnGateway.Id,
            VpnGatewayServiceConnection = "3066f374-97f7-4138-b59d-20a8414f49a8",
        });
    
        var example_1 = Ibm.GetIsVpnGatewayServiceConnection.Invoke(new()
        {
            VpnGatewayName = exampleIbmIsVpnGateway.Name,
            VpnGatewayServiceConnection = "3066f374-97f7-4138-b59d-20a8414f49a8",
        });
    
    });
    
    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.GetIsVpnGatewayServiceConnectionArgs;
    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.getIsVpnGatewayServiceConnection(GetIsVpnGatewayServiceConnectionArgs.builder()
                .vpnGateway(exampleIbmIsVpnGateway.id())
                .vpnGatewayServiceConnection("3066f374-97f7-4138-b59d-20a8414f49a8")
                .build());
    
            final var example-1 = IbmFunctions.getIsVpnGatewayServiceConnection(GetIsVpnGatewayServiceConnectionArgs.builder()
                .vpnGatewayName(exampleIbmIsVpnGateway.name())
                .vpnGatewayServiceConnection("3066f374-97f7-4138-b59d-20a8414f49a8")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: ibm:getIsVpnGatewayServiceConnection
          arguments:
            vpnGateway: ${exampleIbmIsVpnGateway.id}
            vpnGatewayServiceConnection: 3066f374-97f7-4138-b59d-20a8414f49a8
      example-1:
        fn::invoke:
          function: ibm:getIsVpnGatewayServiceConnection
          arguments:
            vpnGatewayName: ${exampleIbmIsVpnGateway.name}
            vpnGatewayServiceConnection: 3066f374-97f7-4138-b59d-20a8414f49a8
    

    Using getIsVpnGatewayServiceConnection

    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 getIsVpnGatewayServiceConnection(args: GetIsVpnGatewayServiceConnectionArgs, opts?: InvokeOptions): Promise<GetIsVpnGatewayServiceConnectionResult>
    function getIsVpnGatewayServiceConnectionOutput(args: GetIsVpnGatewayServiceConnectionOutputArgs, opts?: InvokeOptions): Output<GetIsVpnGatewayServiceConnectionResult>
    def get_is_vpn_gateway_service_connection(vpn_gateway: Optional[str] = None,
                                              vpn_gateway_name: Optional[str] = None,
                                              vpn_gateway_service_connection: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetIsVpnGatewayServiceConnectionResult
    def get_is_vpn_gateway_service_connection_output(vpn_gateway: Optional[pulumi.Input[str]] = None,
                                              vpn_gateway_name: Optional[pulumi.Input[str]] = None,
                                              vpn_gateway_service_connection: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetIsVpnGatewayServiceConnectionResult]
    func GetIsVpnGatewayServiceConnection(ctx *Context, args *GetIsVpnGatewayServiceConnectionArgs, opts ...InvokeOption) (*GetIsVpnGatewayServiceConnectionResult, error)
    func GetIsVpnGatewayServiceConnectionOutput(ctx *Context, args *GetIsVpnGatewayServiceConnectionOutputArgs, opts ...InvokeOption) GetIsVpnGatewayServiceConnectionResultOutput

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

    public static class GetIsVpnGatewayServiceConnection 
    {
        public static Task<GetIsVpnGatewayServiceConnectionResult> InvokeAsync(GetIsVpnGatewayServiceConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetIsVpnGatewayServiceConnectionResult> Invoke(GetIsVpnGatewayServiceConnectionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIsVpnGatewayServiceConnectionResult> getIsVpnGatewayServiceConnection(GetIsVpnGatewayServiceConnectionArgs args, InvokeOptions options)
    public static Output<GetIsVpnGatewayServiceConnectionResult> getIsVpnGatewayServiceConnection(GetIsVpnGatewayServiceConnectionArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getIsVpnGatewayServiceConnection:getIsVpnGatewayServiceConnection
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VpnGatewayServiceConnection string

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    VpnGateway string
    The VPN gateway identifier.
    VpnGatewayName string
    The VPN gateway name.
    VpnGatewayServiceConnection string

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    VpnGateway string
    The VPN gateway identifier.
    VpnGatewayName string
    The VPN gateway name.
    vpnGatewayServiceConnection String

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    vpnGateway String
    The VPN gateway identifier.
    vpnGatewayName String
    The VPN gateway name.
    vpnGatewayServiceConnection string

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    vpnGateway string
    The VPN gateway identifier.
    vpnGatewayName string
    The VPN gateway name.
    vpn_gateway_service_connection str

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    vpn_gateway str
    The VPN gateway identifier.
    vpn_gateway_name str
    The VPN gateway name.
    vpnGatewayServiceConnection String

    The VPN gateway service connection identifier.

    Note Provide either one of vpn_gateway, vpn_gateway_name to identifiy vpn gateway.

    vpnGateway String
    The VPN gateway identifier.
    vpnGatewayName String
    The VPN gateway name.

    getIsVpnGatewayServiceConnection Result

    The following output properties are available:

    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    Creators List<GetIsVpnGatewayServiceConnectionCreator>
    (List) Nested scheme for creator:
    Id string
    The unique identifier for this VPN gateway service connection.
    LifecycleReasons List<GetIsVpnGatewayServiceConnectionLifecycleReason>
    (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<GetIsVpnGatewayServiceConnectionStatusReason>
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    VpnGatewayServiceConnection string
    VpnGateway string
    VpnGatewayName string
    CreatedAt string
    (String) The date and time that this VPN gateway connection was created.
    Creators []GetIsVpnGatewayServiceConnectionCreator
    (List) Nested scheme for creator:
    Id string
    The unique identifier for this VPN gateway service connection.
    LifecycleReasons []GetIsVpnGatewayServiceConnectionLifecycleReason
    (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 []GetIsVpnGatewayServiceConnectionStatusReason
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    VpnGatewayServiceConnection string
    VpnGateway string
    VpnGatewayName string
    createdAt String
    (String) The date and time that this VPN gateway connection was created.
    creators List<GetIsVpnGatewayServiceConnectionCreator>
    (List) Nested scheme for creator:
    id String
    The unique identifier for this VPN gateway service connection.
    lifecycleReasons List<GetIsVpnGatewayServiceConnectionLifecycleReason>
    (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<GetIsVpnGatewayServiceConnectionStatusReason>
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    vpnGatewayServiceConnection String
    vpnGateway String
    vpnGatewayName String
    createdAt string
    (String) The date and time that this VPN gateway connection was created.
    creators GetIsVpnGatewayServiceConnectionCreator[]
    (List) Nested scheme for creator:
    id string
    The unique identifier for this VPN gateway service connection.
    lifecycleReasons GetIsVpnGatewayServiceConnectionLifecycleReason[]
    (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 GetIsVpnGatewayServiceConnectionStatusReason[]
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    vpnGatewayServiceConnection string
    vpnGateway string
    vpnGatewayName string
    created_at str
    (String) The date and time that this VPN gateway connection was created.
    creators Sequence[GetIsVpnGatewayServiceConnectionCreator]
    (List) Nested scheme for creator:
    id str
    The unique identifier for this VPN gateway service connection.
    lifecycle_reasons Sequence[GetIsVpnGatewayServiceConnectionLifecycleReason]
    (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[GetIsVpnGatewayServiceConnectionStatusReason]
    (List) The reasons for the current VPN gateway service connection status (if any). Nested status_reasons:
    vpn_gateway_service_connection str
    vpn_gateway str
    vpn_gateway_name str
    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:
    vpnGatewayServiceConnection String
    vpnGateway String
    vpnGatewayName String

    Supporting Types

    GetIsVpnGatewayServiceConnectionCreator

    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.

    GetIsVpnGatewayServiceConnectionLifecycleReason

    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

    GetIsVpnGatewayServiceConnectionStatusReason

    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