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

ibm.getPiCloudConnection

Explore with Pulumi AI

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

    Retrieve information about an existing IBM Cloud Power Virtual Server Cloud cloud connection. For more information, about IBM power virtual server cloud, see getting started with IBM Power Systems Virtual Servers.

    Example Usage

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

const example = ibm.getPiCloudConnection({
    piCloudConnectionName: "test_cloud_connection",
    piCloudInstanceId: "<value of the cloud_instance_id>",
});

    import pulumi
import pulumi_ibm as ibm

example = ibm.get_pi_cloud_connection(pi_cloud_connection_name="test_cloud_connection",
    pi_cloud_instance_id="<value of the cloud_instance_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.LookupPiCloudConnection(ctx, &ibm.LookupPiCloudConnectionArgs{
			PiCloudConnectionName: "test_cloud_connection",
			PiCloudInstanceId:     "<value of the cloud_instance_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.GetPiCloudConnection.Invoke(new()
    {
        PiCloudConnectionName = "test_cloud_connection",
        PiCloudInstanceId = "<value of the cloud_instance_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.GetPiCloudConnectionArgs;
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.getPiCloudConnection(GetPiCloudConnectionArgs.builder()
            .piCloudConnectionName("test_cloud_connection")
            .piCloudInstanceId("<value of the cloud_instance_id>")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: ibm:getPiCloudConnection
      arguments:
        piCloudConnectionName: test_cloud_connection
        piCloudInstanceId: <value of the cloud_instance_id>

    Notes

    • Please find supported Regions for endpoints.
    • If a Power cloud instance is provisioned at lon04, The provider level attributes should be as follows:
      • region - lon
      • zone - lon04

    Example usage:

    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) {
    }
}

    {}

    Using getPiCloudConnection

    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 getPiCloudConnection(args: GetPiCloudConnectionArgs, opts?: InvokeOptions): Promise<GetPiCloudConnectionResult>
function getPiCloudConnectionOutput(args: GetPiCloudConnectionOutputArgs, opts?: InvokeOptions): Output<GetPiCloudConnectionResult>
    def get_pi_cloud_connection(id: Optional[str] = None,
                            pi_cloud_connection_name: Optional[str] = None,
                            pi_cloud_instance_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetPiCloudConnectionResult
def get_pi_cloud_connection_output(id: Optional[pulumi.Input[str]] = None,
                            pi_cloud_connection_name: Optional[pulumi.Input[str]] = None,
                            pi_cloud_instance_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetPiCloudConnectionResult]
    func LookupPiCloudConnection(ctx *Context, args *LookupPiCloudConnectionArgs, opts ...InvokeOption) (*LookupPiCloudConnectionResult, error)
func LookupPiCloudConnectionOutput(ctx *Context, args *LookupPiCloudConnectionOutputArgs, opts ...InvokeOption) LookupPiCloudConnectionResultOutput

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

    public static class GetPiCloudConnection 
{
    public static Task<GetPiCloudConnectionResult> InvokeAsync(GetPiCloudConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetPiCloudConnectionResult> Invoke(GetPiCloudConnectionInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPiCloudConnectionResult> getPiCloudConnection(GetPiCloudConnectionArgs args, InvokeOptions options)
public static Output<GetPiCloudConnectionResult> getPiCloudConnection(GetPiCloudConnectionArgs args, InvokeOptions options)

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

    The following arguments are supported:

    PiCloudConnectionName string
    The cloud connection name to be used.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The unique identifier of the cloud connection.
    PiCloudConnectionName string
    The cloud connection name to be used.
    PiCloudInstanceId string
    The GUID of the service instance associated with an account.
    Id string
    (String) The unique identifier of the cloud connection.
    piCloudConnectionName String
    The cloud connection name to be used.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of the cloud connection.
    piCloudConnectionName string
    The cloud connection name to be used.
    piCloudInstanceId string
    The GUID of the service instance associated with an account.
    id string
    (String) The unique identifier of the cloud connection.
    pi_cloud_connection_name str
    The cloud connection name to be used.
    pi_cloud_instance_id str
    The GUID of the service instance associated with an account.
    id str
    (String) The unique identifier of the cloud connection.
    piCloudConnectionName String
    The cloud connection name to be used.
    piCloudInstanceId String
    The GUID of the service instance associated with an account.
    id String
    (String) The unique identifier of the cloud connection.

    getPiCloudConnection Result

    The following output properties are available:

    ClassicEnabled bool
    (Boolean) Enable classic endpoint destination.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GlobalRouting bool
    (String) Enable global routing for this cloud connection.
    GreDestinationAddress string
    (String) GRE destination IP address.
    GreSourceAddress string
    (String) GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    Id string
    (String) The unique identifier of the cloud connection.
    Metered bool
    (String) Enable metering for this cloud connection.
    Networks List<string>
    (Set) Set of Networks attached to this cloud connection.
    PiCloudConnectionName string
    PiCloudInstanceId string
    Port string
    (String) Port.
    Speed double
    (Integer) Speed of the cloud connection (speed in megabits per second).
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    VpcCrns List<string>
    (Set) Set of VPCs attached to this cloud connection.
    VpcEnabled bool
    (Boolean) Enable VPC for this cloud connection.
    ClassicEnabled bool
    (Boolean) Enable classic endpoint destination.
    ConnectionMode string
    (String) Type of service the gateway is attached to.
    GlobalRouting bool
    (String) Enable global routing for this cloud connection.
    GreDestinationAddress string
    (String) GRE destination IP address.
    GreSourceAddress string
    (String) GRE auto-assigned source IP address.
    IbmIpAddress string
    (String) The IBM IP address.
    Id string
    (String) The unique identifier of the cloud connection.
    Metered bool
    (String) Enable metering for this cloud connection.
    Networks []string
    (Set) Set of Networks attached to this cloud connection.
    PiCloudConnectionName string
    PiCloudInstanceId string
    Port string
    (String) Port.
    Speed float64
    (Integer) Speed of the cloud connection (speed in megabits per second).
    Status string
    (String) Link status.
    UserIpAddress string
    (String) User IP address.
    VpcCrns []string
    (Set) Set of VPCs attached to this cloud connection.
    VpcEnabled bool
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled Boolean
    (Boolean) Enable classic endpoint destination.
    connectionMode String
    (String) Type of service the gateway is attached to.
    globalRouting Boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress String
    (String) GRE destination IP address.
    greSourceAddress String
    (String) GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    id String
    (String) The unique identifier of the cloud connection.
    metered Boolean
    (String) Enable metering for this cloud connection.
    networks List<String>
    (Set) Set of Networks attached to this cloud connection.
    piCloudConnectionName String
    piCloudInstanceId String
    port String
    (String) Port.
    speed Double
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.
    vpcCrns List<String>
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled Boolean
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled boolean
    (Boolean) Enable classic endpoint destination.
    connectionMode string
    (String) Type of service the gateway is attached to.
    globalRouting boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress string
    (String) GRE destination IP address.
    greSourceAddress string
    (String) GRE auto-assigned source IP address.
    ibmIpAddress string
    (String) The IBM IP address.
    id string
    (String) The unique identifier of the cloud connection.
    metered boolean
    (String) Enable metering for this cloud connection.
    networks string[]
    (Set) Set of Networks attached to this cloud connection.
    piCloudConnectionName string
    piCloudInstanceId string
    port string
    (String) Port.
    speed number
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status string
    (String) Link status.
    userIpAddress string
    (String) User IP address.
    vpcCrns string[]
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled boolean
    (Boolean) Enable VPC for this cloud connection.
    classic_enabled bool
    (Boolean) Enable classic endpoint destination.
    connection_mode str
    (String) Type of service the gateway is attached to.
    global_routing bool
    (String) Enable global routing for this cloud connection.
    gre_destination_address str
    (String) GRE destination IP address.
    gre_source_address str
    (String) GRE auto-assigned source IP address.
    ibm_ip_address str
    (String) The IBM IP address.
    id str
    (String) The unique identifier of the cloud connection.
    metered bool
    (String) Enable metering for this cloud connection.
    networks Sequence[str]
    (Set) Set of Networks attached to this cloud connection.
    pi_cloud_connection_name str
    pi_cloud_instance_id str
    port str
    (String) Port.
    speed float
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status str
    (String) Link status.
    user_ip_address str
    (String) User IP address.
    vpc_crns Sequence[str]
    (Set) Set of VPCs attached to this cloud connection.
    vpc_enabled bool
    (Boolean) Enable VPC for this cloud connection.
    classicEnabled Boolean
    (Boolean) Enable classic endpoint destination.
    connectionMode String
    (String) Type of service the gateway is attached to.
    globalRouting Boolean
    (String) Enable global routing for this cloud connection.
    greDestinationAddress String
    (String) GRE destination IP address.
    greSourceAddress String
    (String) GRE auto-assigned source IP address.
    ibmIpAddress String
    (String) The IBM IP address.
    id String
    (String) The unique identifier of the cloud connection.
    metered Boolean
    (String) Enable metering for this cloud connection.
    networks List<String>
    (Set) Set of Networks attached to this cloud connection.
    piCloudConnectionName String
    piCloudInstanceId String
    port String
    (String) Port.
    speed Number
    (Integer) Speed of the cloud connection (speed in megabits per second).
    status String
    (String) Link status.
    userIpAddress String
    (String) User IP address.
    vpcCrns List<String>
    (Set) Set of VPCs attached to this cloud connection.
    vpcEnabled Boolean
    (Boolean) Enable VPC for this cloud connection.

    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